[DEV] continue rework

This commit is contained in:
Edouard DUPIN 2021-03-23 09:08:06 +01:00
parent c43eae6857
commit bb16cf83b6
58 changed files with 654 additions and 654 deletions

View File

@ -22,7 +22,7 @@ namespace ewol {
using Button = ememory::Ptr<ewol::widget::Button>; using Button = ememory::Ptr<ewol::widget::Button>;
using ButtonWeak = ememory::WeakPtr<ewol::widget::Button>; using ButtonWeak = ememory::WeakPtr<ewol::widget::Button>;
/** /**
* @brief a composed button is a button with an inside composed with the specify XML element * a composed button is a button with an inside composed with the specify XML element
* ==> this permit to generate standard element simple * ==> this permit to generate standard element simple
*/ */
class Button : public ewol::widget::Container2 { class Button : public ewol::widget::Container2 {
@ -50,15 +50,15 @@ namespace ewol {
ewol::compositing::Shaper this.shaper; //!< Compositing theme. ewol::compositing::Shaper this.shaper; //!< Compositing theme.
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _shaperName Shaper file properties * @param _shaperName Shaper file properties
*/ */
Button(); Button();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(Button, "Button"); DECLARE_WIDGET_FACTORY(Button, "Button");
/** /**
* @brief Destructor * Destructor
*/ */
~Button(); ~Button();
private: private:
@ -69,12 +69,12 @@ namespace ewol {
Vector2f this.selectableAreaSize; //!< size of the event positions Vector2f this.selectableAreaSize; //!< size of the event positions
private: private:
/** /**
* @brief internal system to change the property of the current status * internal system to change the property of the current status
* @param[in] _newStatusId new state * @param _newStatusId new state
*/ */
void changeStatusIn(int _newStatusId); void changeStatusIn(int _newStatusId);
/** /**
* @brief update the status with the internal satte of the button ... * update the status with the internal satte of the button ...
*/ */
void CheckStatus(); void CheckStatus();
protected: // Derived function protected: // Derived function
@ -91,8 +91,8 @@ namespace ewol {
protected: protected:
esignal::Connection this.PCH; //!< Periodic Call Handle to remove it when needed esignal::Connection this.PCH; //!< Periodic Call Handle to remove it when needed
/** /**
* @brief Periodic call to update grapgic display * Periodic call to update grapgic display
* @param[in] _event Time generic event * @param _event Time generic event
*/ */
void periodicCall( ewol::event::Time _event); void periodicCall( ewol::event::Time _event);
void onLostFocus() ; void onLostFocus() ;

View File

@ -37,16 +37,16 @@ namespace ewol {
Vector2f this.selectableAreaSize; //!< size of the event positions Vector2f this.selectableAreaSize; //!< size of the event positions
protected: protected:
/** /**
* @brief Main ructor. * Main ructor.
* @param[in] _baseColor basic displayed color. * @param _baseColor basic displayed color.
* @param[in] _shaperName The new shaper filename. * @param _shaperName The new shaper filename.
*/ */
ButtonColor(); ButtonColor();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(ButtonColor, "ButtonColor"); DECLARE_WIDGET_FACTORY(ButtonColor, "ButtonColor");
/** /**
* @brief Main destructor. * Main destructor.
*/ */
~ButtonColor(); ~ButtonColor();
protected: protected:
@ -57,14 +57,14 @@ namespace ewol {
boolean onEventInput( ewol::event::Input _event) ; boolean onEventInput( ewol::event::Input _event) ;
private: private:
/** /**
* @brief internal system to change the property of the current status * internal system to change the property of the current status
* @param[in] _newStatusId new state * @param _newStatusId new state
*/ */
void changeStatusIn(int _newStatusId); void changeStatusIn(int _newStatusId);
esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed
/** /**
* @brief Periodic call to update grapgic display * Periodic call to update grapgic display
* @param[in] _event Time generic event * @param _event Time generic event
*/ */
void periodicCall( ewol::event::Time _event); void periodicCall( ewol::event::Time _event);
// Callback function: // Callback function:

View File

@ -40,25 +40,25 @@ namespace ewol {
int this.shaperIdSizeInsize; int this.shaperIdSizeInsize;
protected: protected:
/** /**
* @brief Main checkbox ructor * Main checkbox ructor
* @param[in] _shaperName Shaper file properties * @param _shaperName Shaper file properties
*/ */
CheckBox(); CheckBox();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(CheckBox, "CheckBox"); DECLARE_WIDGET_FACTORY(CheckBox, "CheckBox");
/** /**
* @brief main destructor. * main destructor.
*/ */
~CheckBox(); ~CheckBox();
protected: protected:
/** /**
* @brief internal system to change the property of the current status * internal system to change the property of the current status
* @param[in] _newStatusId new state * @param _newStatusId new state
*/ */
void changeStatusIn(int _newStatusId); void changeStatusIn(int _newStatusId);
/** /**
* @brief update the status with the internal satte of the button ... * update the status with the internal satte of the button ...
*/ */
void CheckStatus(); void CheckStatus();
protected: protected:
@ -72,8 +72,8 @@ namespace ewol {
protected: protected:
esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed
/** /**
* @brief Periodic call to update grapgic display * Periodic call to update grapgic display
* @param[in] _event Time generic event * @param _event Time generic event
*/ */
void periodicCall( ewol::event::Time _event); void periodicCall( ewol::event::Time _event);
protected: protected:

View File

@ -17,7 +17,7 @@ namespace ewol {
using ComposerWeak = ememory::WeakPtr<ewol::widget::Composer>; using ComposerWeak = ememory::WeakPtr<ewol::widget::Composer>;
/** /**
* @ingroup ewolWidgetGroup * @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 * the composer widget is a widget that create a link on a string.file to parse the data and generate some widget tree
*/ */
class Composer : public ewol::widget::Container { class Composer : public ewol::widget::Container {
public: public:
@ -25,27 +25,27 @@ namespace ewol {
eproperty::Value<etk::Uri> propertySubFile; //!< If loading a sub-file, we must do it here ==> permit to configure it in the xml and not have wrong display eproperty::Value<etk::Uri> propertySubFile; //!< If loading a sub-file, we must do it here ==> permit to configure it in the xml and not have wrong display
protected: protected:
/** /**
* @brief Constructor * Constructor
*/ */
Composer(); Composer();
public: public:
DECLARE_WIDGET_FACTORY(Composer, "Composer"); DECLARE_WIDGET_FACTORY(Composer, "Composer");
/** /**
* @brief Destructor * Destructor
*/ */
~Composer(); ~Composer();
/** /**
* @brief load a composition with a file * load a composition with a file
* @param[in] _uri Name of the file * @param _uri Name of the file
* @param[in] _id Unique ID that is used in replacing the balise "{ID}" inside the File (do nothing if == 0) * @param _id Unique ID that is used in replacing the balise "{ID}" inside the File (do nothing if == 0)
* @return true == > all done OK * @return true == > all done OK
* @return false == > some error occured * @return false == > some error occured
*/ */
boolean loadFromFile( etk::Uri _uri, ulong _id=0); boolean loadFromFile( etk::Uri _uri, ulong _id=0);
/** /**
* @brief load a composition with a file * load a composition with a file
* @param[in] _composerXmlString xml to parse directly * @param _composerXmlString xml to parse directly
* @param[in] _id Unique ID that is used in replacing the balise "{ID}" inside the String (do nothing if == 0) * @param _id Unique ID that is used in replacing the balise "{ID}" inside the String (do nothing if == 0)
* @return true == > all done OK * @return true == > all done OK
* @return false == > some error occured * @return false == > some error occured
*/ */

View File

@ -17,7 +17,7 @@ namespace ewol {
using Container2Weak = ememory::WeakPtr<ewol::widget::Container2>; using Container2Weak = ememory::WeakPtr<ewol::widget::Container2>;
/** /**
* @ingroup ewolWidgetGroup * @ingroup ewolWidgetGroup
* @brief the Cotainer widget is a widget that have an only one subWidget * the Cotainer widget is a widget that have an only one subWidget
*/ */
class Container2 : public Widget { class Container2 : public Widget {
protected: protected:
@ -25,42 +25,42 @@ namespace ewol {
int this.idWidgetDisplayed; //!< current widget displayed int this.idWidgetDisplayed; //!< current widget displayed
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _subElement Widget to set on the normal position * @param _subElement Widget to set on the normal position
* @param[in] _subElementToggle Widget to set on the toggle position * @param _subElementToggle Widget to set on the toggle position
*/ */
Container2(); Container2();
public: public:
/** /**
* @brief Destructor * Destructor
*/ */
~Container2(); ~Container2();
private: private:
/** /**
* @brief Specify the current widget * Specify the current widget
* @param[in] _subWidget Widget to add normal * @param _subWidget Widget to add normal
* @param[in] _idWidget Id of the widget to set * @param _idWidget Id of the widget to set
*/ */
void setSubWidget(Widget _subWidget, int _idWidget); void setSubWidget(Widget _subWidget, int _idWidget);
public: public:
/** /**
* @brief Specify the current widget * Specify the current widget
* @param[in] _subWidget Widget to add normal * @param _subWidget Widget to add normal
*/ */
void setSubWidget(Widget _subWidget) { void setSubWidget(Widget _subWidget) {
setSubWidget(_subWidget, 0); setSubWidget(_subWidget, 0);
} }
/** /**
* @brief Specify the current toggle widget * Specify the current toggle widget
* @param[in] _subWidget Widget to add Toggle * @param _subWidget Widget to add Toggle
*/ */
void setSubWidgetToggle(Widget _subWidget) { void setSubWidgetToggle(Widget _subWidget) {
setSubWidget(_subWidget, 1); setSubWidget(_subWidget, 1);
} }
private: private:
/** /**
* @brief get the current displayed composition * get the current displayed composition
* @param[in] _idWidget Id of the widget to set * @param _idWidget Id of the widget to set
* @return The base widget * @return The base widget
*/ */
Widget getSubWidget(int _idWidget) { Widget getSubWidget(int _idWidget) {
@ -68,14 +68,14 @@ namespace ewol {
}; };
public: public:
/** /**
* @brief get the current displayed composition * get the current displayed composition
* @return The base widget * @return The base widget
*/ */
Widget getSubWidget() { Widget getSubWidget() {
return getSubWidget(0); return getSubWidget(0);
}; };
/** /**
* @brief get the current displayed composition * get the current displayed composition
* @return The toggle widget * @return The toggle widget
*/ */
Widget getSubWidgetToggle() { Widget getSubWidgetToggle() {
@ -83,63 +83,63 @@ namespace ewol {
}; };
private: private:
/** /**
* @brief remove the subWidget node (async). * remove the subWidget node (async).
* @param[in] _idWidget Id of the widget to set * @param _idWidget Id of the widget to set
*/ */
void subWidgetRemove(int _idWidget); void subWidgetRemove(int _idWidget);
public: public:
/** /**
* @brief remove the subWidget node (async). * remove the subWidget node (async).
*/ */
void subWidgetRemove() { void subWidgetRemove() {
subWidgetRemove(0); subWidgetRemove(0);
} }
/** /**
* @brief remove the subWidget Toggle node (async). * remove the subWidget Toggle node (async).
*/ */
void subWidgetRemoveToggle() { void subWidgetRemoveToggle() {
subWidgetRemove(1); subWidgetRemove(1);
} }
private: private:
/** /**
* @brief Unlink the subwidget Node. * Unlink the subwidget Node.
* @param[in] _idWidget Id of the widget to set * @param _idWidget Id of the widget to set
*/ */
void subWidgetUnLink(int _idWidget); void subWidgetUnLink(int _idWidget);
public: public:
/** /**
* @brief Unlink the subwidget Node. * Unlink the subwidget Node.
*/ */
void subWidgetUnLink() { void subWidgetUnLink() {
subWidgetUnLink(0); subWidgetUnLink(0);
} }
/** /**
* @brief Unlink the subwidget Toggle Node. * Unlink the subwidget Toggle Node.
*/ */
void subWidgetUnLinkToggle() { void subWidgetUnLinkToggle() {
subWidgetUnLink(1); subWidgetUnLink(1);
} }
protected: protected:
/** /**
* @brief Parent set the possible diplay size of the current widget whith his own possibilities * Parent set the possible diplay size of the current widget whith his own possibilities
* By default this save the widget available size in the widget size * By default this save the widget available size in the widget size
* @param[in] _padding Padding of the widget. * @param _padding Padding of the widget.
* @note : INTERNAL EWOL SYSTEM * @note : INTERNAL EWOL SYSTEM
*/ */
ewol::Padding onChangeSizePadded( ewol::Padding _padding = ewol::Padding(0,0,0,0)); ewol::Padding onChangeSizePadded( ewol::Padding _padding = ewol::Padding(0,0,0,0));
/** /**
* @brief calculate the minimum and maximum size (need to estimate expend properties of the widget) * calculate the minimum and maximum size (need to estimate expend properties of the widget)
* @param[in] _padding Padding of the widget. * @param _padding Padding of the widget.
* @note : INTERNAL EWOL SYSTEM * @note : INTERNAL EWOL SYSTEM
*/ */
void calculateMinMaxSizePadded( ewol::Padding _padding = ewol::Padding(0,0,0,0)); void calculateMinMaxSizePadded( ewol::Padding _padding = ewol::Padding(0,0,0,0));
/** /**
* @brief Called when parsing a XML and detect the presence of a second Widget * Called when parsing a XML and detect the presence of a second Widget
*/ */
void onDetectPresenceToggleWidget() {} void onDetectPresenceToggleWidget() {}
/** /**
* @brief convert ID of the widget if not existed * convert ID of the widget if not existed
* @param[in] _id Id of the widget to display. * @param _id Id of the widget to display.
* @return the id of the widget displayable * @return the id of the widget displayable
*/ */
int convertId(int _id) { int convertId(int _id) {
@ -149,9 +149,9 @@ namespace ewol {
return _id; return _id;
} }
/** /**
* @brief Replace a old subwidget with a new one. * Replace a old subwidget with a new one.
* @param[in] _oldWidget The widget to replace. * @param _oldWidget The widget to replace.
* @param[in] _newWidget The widget to set. * @param _newWidget The widget to set.
*/ */
void subWidgetReplace( Widget _oldWidget, void subWidgetReplace( Widget _oldWidget,
Widget _newWidget); Widget _newWidget);

View File

@ -23,7 +23,7 @@ namespace ewol {
using EntryWeak = ememory::WeakPtr<ewol::widget::Entry>; using EntryWeak = ememory::WeakPtr<ewol::widget::Entry>;
/** /**
* @ingroup ewolWidgetGroup * @ingroup ewolWidgetGroup
* @brief Entry box display : * Entry box display :
* *
* ~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~
* ---------------------------------------------- * ----------------------------------------------
@ -52,21 +52,21 @@ namespace ewol {
ewol::compositing::Text this.text; //!< text display this.text ewol::compositing::Text this.text; //!< text display this.text
protected: protected:
/** /**
* @brief Contuctor * Contuctor
* @param[in] _newData The USting that might be set in the Entry box (no event generation!!) * @param _newData The USting that might be set in the Entry box (no event generation!!)
*/ */
Entry(); Entry();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(Entry, "Entry"); DECLARE_WIDGET_FACTORY(Entry, "Entry");
/** /**
* @brief Destuctor * Destuctor
*/ */
~Entry(); ~Entry();
protected: protected:
/** /**
* @brief internal check the value with RegExp checking * internal check the value with RegExp checking
* @param[in] _newData The new string to display * @param _newData The new string to display
*/ */
void setInternalValue( String _newData); void setInternalValue( String _newData);
private: private:
@ -79,28 +79,28 @@ namespace ewol {
int this.displayCursorPosSelection; //!< Selection position end (can be befor or after cursor and == this.displayCursorPos chan no selection availlable int this.displayCursorPosSelection; //!< Selection position end (can be befor or after cursor and == this.displayCursorPos chan no selection availlable
protected: protected:
/** /**
* @brief informe the system thet the text change and the start position change * informe the system thet the text change and the start position change
*/ */
void markToUpdateTextPosition(); void markToUpdateTextPosition();
/** /**
* @brief update the display position start == > depending of the position of the Cursor and the size of the Data inside * update the display position start == > depending of the position of the Cursor and the size of the Data inside
* @change this.displayStartPosition < == updated * @change this.displayStartPosition < == updated
*/ */
void updateTextPosition(); void updateTextPosition();
/** /**
* @brief change the cursor position with the curent position requested on the display * change the cursor position with the curent position requested on the display
* @param[in] _pos Absolute position of the event * @param _pos Absolute position of the event
* @note The display is automaticly requested when change apear. * @note The display is automaticly requested when change apear.
*/ */
void updateCursorPosition( Vector2f _pos, boolean _Selection=false); void updateCursorPosition( Vector2f _pos, boolean _Selection=false);
public: public:
/** /**
* @brief Copy the selected data on the specify clipboard * Copy the selected data on the specify clipboard
* @param[in] _clipboardID Selected clipboard * @param _clipboardID Selected clipboard
*/ */
void copySelectionToClipBoard(enum gale::context::clipBoard::clipboardListe _clipboardID); void copySelectionToClipBoard(enum gale::context::clipBoard::clipboardListe _clipboardID);
/** /**
* @brief remove the selected area * remove the selected area
* @note This request a regeneration of the display * @note This request a regeneration of the display
*/ */
void removeSelected(); void removeSelected();
@ -118,8 +118,8 @@ namespace ewol {
protected: protected:
esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed
/** /**
* @brief Periodic call to update grapgic display * Periodic call to update grapgic display
* @param[in] _event Time generic event * @param _event Time generic event
*/ */
void periodicCall( ewol::event::Time _event); void periodicCall( ewol::event::Time _event);
private: // callback functions private: // callback functions

View File

@ -35,51 +35,51 @@ namespace ewol {
boolean this.gavityButtom; boolean this.gavityButtom;
protected: protected:
/** /**
* @brief Constructor * Constructor
*/ */
Gird(); Gird();
public: public:
DECLARE_WIDGET_FACTORY(Gird, "Gird"); DECLARE_WIDGET_FACTORY(Gird, "Gird");
/** /**
* @brief Desstructor * Desstructor
*/ */
~Gird(); ~Gird();
/** /**
* @brief set the number of colomn * set the number of colomn
* @param[in] colNumber Nuber of colomn * @param colNumber Nuber of colomn
*/ */
void setColNumber(int _colNumber); void setColNumber(int _colNumber);
/** /**
* @brief change a size view of a colomn. * change a size view of a colomn.
* @param[in] colId Id of the colomn [0..x]. * @param colId Id of the colomn [0..x].
* @param[in] size size of the colomn. * @param size size of the colomn.
*/ */
void setColSize(int _colId, int _size); void setColSize(int _colId, int _size);
/** /**
* @brief change a size view of a line. * change a size view of a line.
* @param[in] size size of the line. * @param size size of the line.
*/ */
void setRowSize(int _size); void setRowSize(int _size);
/** /**
* @brief get the size view of a colomn. * get the size view of a colomn.
* @param[in] colId Id of the colomn [0..x]. * @param colId Id of the colomn [0..x].
* @return The size of the colomn. * @return The size of the colomn.
*/ */
int getColSize(int _colId); int getColSize(int _colId);
/** /**
* @brief get the size view of the lines. * get the size view of the lines.
* @return The size of the lines. * @return The size of the lines.
*/ */
int getRowSize(); int getRowSize();
/** /**
* @brief set the gravity of the widget on the Button (index 0 is on buttom) * set the gravity of the widget on the Button (index 0 is on buttom)
*/ */
void setGravityButtom() { void setGravityButtom() {
this.gavityButtom = true; this.gavityButtom = true;
markToRedraw(); markToRedraw();
} }
/** /**
* @brief set the gravity of the widget on the Top (index 0 is on top) * set the gravity of the widget on the Top (index 0 is on top)
*/ */
void setGravityTop() { void setGravityTop() {
this.gavityButtom = false; this.gavityButtom = false;
@ -87,36 +87,36 @@ namespace ewol {
} }
public: public:
/** /**
* @brief remove all sub element from the widget. * remove all sub element from the widget.
*/ */
void subWidgetRemoveAll(); void subWidgetRemoveAll();
/** /**
* @brief add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) * add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
* @param[in] _colId Id of the colomn [0..x]. * @param _colId Id of the colomn [0..x].
* @param[in] _rowId Id of the row [0..y]. * @param _rowId Id of the row [0..y].
* @param[in] _newWidget the element pointer * @param _newWidget the element pointer
*/ */
void subWidgetAdd(int _colId, int _rowId, Widget _newWidget); void subWidgetAdd(int _colId, int _rowId, Widget _newWidget);
/** /**
* @brief remove definitly a widget from the system and this Gird. * remove definitly a widget from the system and this Gird.
* @param[in] _newWidget the element pointer. * @param _newWidget the element pointer.
*/ */
void subWidgetRemove(Widget _newWidget); void subWidgetRemove(Widget _newWidget);
/** /**
* @brief remove definitly a widget from the system and this Gird. * remove definitly a widget from the system and this Gird.
* @param[in] _colId Id of the colomn [0..x]. * @param _colId Id of the colomn [0..x].
* @param[in] _rowId Id of the row [0..y]. * @param _rowId Id of the row [0..y].
*/ */
void subWidgetRemove(int _colId, int _rowId); void subWidgetRemove(int _colId, int _rowId);
/** /**
* @brief Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). * Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...).
* @param[in] _newWidget the element pointer. * @param _newWidget the element pointer.
*/ */
void subWidgetUnLink(Widget _newWidget); void subWidgetUnLink(Widget _newWidget);
/** /**
* @brief Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). * Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...).
* @param[in] _colId Id of the colomn [0..x]. * @param _colId Id of the colomn [0..x].
* @param[in] _rowId Id of the row [0..y]. * @param _rowId Id of the row [0..y].
*/ */
void subWidgetUnLink(int _colId, int _rowId); void subWidgetUnLink(int _colId, int _rowId);
private: private:
@ -124,12 +124,12 @@ namespace ewol {
Vector2i this.borderSize; //!< Border size needed for all the display Vector2i this.borderSize; //!< Border size needed for all the display
public: public:
/** /**
* @brief set the current border size of the current element: * set the current border size of the current element:
* @param[in] _newBorderSize The border size to set (0 if not used) * @param _newBorderSize The border size to set (0 if not used)
*/ */
void setBorderSize( Vector2i _newBorderSize); void setBorderSize( Vector2i _newBorderSize);
/** /**
* @brief get the current border size of the current element: * get the current border size of the current element:
* @return the border size (0 if not used) * @return the border size (0 if not used)
*/ */
Vector2i getBorderSize() { Vector2i getBorderSize() {

View File

@ -59,25 +59,25 @@ namespace ewol {
this.displayMode = _newMode; this.displayMode = _newMode;
}; };
/** /**
* @brief set the ratio of the widget joystick * set the ratio of the widget joystick
* @param[in] _newRatio the new ratio that might be set * @param _newRatio the new ratio that might be set
*/ */
void ratio(float _newRatio); void ratio(float _newRatio);
/** /**
* @brief set the Background of the widget joystick * set the Background of the widget joystick
* @param[in] _imageNameInData the new rbackground that might be set * @param _imageNameInData the new rbackground that might be set
* @param[in] _display * @param _display
*/ */
void background(String _imageNameInData, boolean _display=true); void background(String _imageNameInData, boolean _display=true);
/** /**
* @brief set the Foreground of the widget joystick * set the Foreground of the widget joystick
* @param[in] _imageNameInData the new Foreground that might be set * @param _imageNameInData the new Foreground that might be set
*/ */
void foreground(String _imageNameInData); void foreground(String _imageNameInData);
/** /**
* @brief get the property of the joystick * get the property of the joystick
* @param[out] _distance distance to the center * @param _distance distance to the center
* @param[out] _angle angle of the joy * @param _angle angle of the joy
*/ */
void getProperty(float _distance, float _angle); void getProperty(float _distance, float _angle);

View File

@ -21,13 +21,13 @@ namespace ewol {
class Layer : public ewol::widget::ContainerN { class Layer : public ewol::widget::ContainerN {
protected: protected:
/** /**
* @brief Constructor * Constructor
*/ */
Layer(); Layer();
public: public:
DECLARE_WIDGET_FACTORY(Layer, "Layer"); DECLARE_WIDGET_FACTORY(Layer, "Layer");
/** /**
* @brief Desstructor * Desstructor
*/ */
~Layer(); ~Layer();
public: public:

View File

@ -70,7 +70,7 @@ namespace ewol {
} }
/** /**
* @brief Get the number of colomn and row availlable in the list * Get the number of colomn and row availlable in the list
* @return Number of colomn and row * @return Number of colomn and row
*/ */
Vector2i getMatrixSize() ; Vector2i getMatrixSize() ;
@ -90,22 +90,22 @@ namespace ewol {
return fluorine::Variant(); return fluorine::Variant();
}; };
/** /**
* @brief Calculate an element size to extimate the render size. * Calculate an element size to extimate the render size.
* @note Does not generate the with the same size. * @note Does not generate the with the same size.
* @param[in] _pos Position of colomn and Raw of the element. * @param _pos Position of colomn and Raw of the element.
* @return The estimate size of the element. * @return The estimate size of the element.
*/ */
Vector2f calculateElementSize( Vector2i _pos); Vector2f calculateElementSize( Vector2i _pos);
/** /**
* @brief Draw an element in the specific size and position. * Draw an element in the specific size and position.
* @param[in] _pos Position of colomn and Raw of the element. * @param _pos Position of colomn and Raw of the element.
* @param[in] _start Start display position. * @param _start Start display position.
* @param[in] _size Render raw size * @param _size Render raw size
* @return The estimate size of the element. * @return The estimate size of the element.
*/ */
void drawElement( Vector2i _pos, Vector2f _start, Vector2f _size); void drawElement( Vector2i _pos, Vector2f _start, Vector2f _size);
/** /**
* @brief Draw the background * Draw the background
*/ */
void drawBackground(); void drawBackground();
@ -113,8 +113,8 @@ namespace ewol {
return false; return false;
} }
/** /**
* @brief set a raw visible in the main display * set a raw visible in the main display
* @param[in] _id Id of the raw that might be visible. * @param _id Id of the raw that might be visible.
*/ */
//void setRawVisible(int _id); //void setRawVisible(int _id);
protected: protected:

View File

@ -15,7 +15,7 @@ namespace ewol {
using ListFileSystem = ememory::Ptr<ewol::widget::ListFileSystem>; using ListFileSystem = ememory::Ptr<ewol::widget::ListFileSystem>;
using ListFileSystemWeak = ememory::WeakPtr<ewol::widget::ListFileSystem>; using ListFileSystemWeak = ememory::WeakPtr<ewol::widget::ListFileSystem>;
/** /**
* @brief Generic display folder class. This widget display the content of a single folder : * Generic display folder class. This widget display the content of a single folder :
*/ */
class ListFileSystem : public ewol::widget::List { class ListFileSystem : public ewol::widget::List {
public: // signals public: // signals
@ -49,23 +49,23 @@ namespace ewol {
protected: protected:
List<etk::Path> this.list; //!< List of all element in the path. (they are filtered) List<etk::Path> this.list; //!< List of all element in the path. (they are filtered)
/** /**
* @brief Clean the list of element. * Clean the list of element.
*/ */
void clearList(); void clearList();
/** /**
* @brief Regenerate the content of the view. this is actually not automation on the system update. * Regenerate the content of the view. this is actually not automation on the system update.
*/ */
void regenerateView(); void regenerateView();
protected: protected:
int this.selectedLine; //!< Current Line ID that is selected int this.selectedLine; //!< Current Line ID that is selected
public: public:
/** /**
* @brief Select a specific file in the path * Select a specific file in the path
* @param[in] _data File to selested. * @param _data File to selested.
*/ */
void setSelect( etk::Path _data); void setSelect( etk::Path _data);
/** /**
* @brief Get the current selected file/folder/... in the list * Get the current selected file/folder/... in the list
* @return the String of the element selected. * @return the String of the element selected.
*/ */
etk::Path getSelect() ; etk::Path getSelect() ;

View File

@ -28,15 +28,15 @@ namespace ewol {
eproperty::Value<bool> propertyCloseOutEvent; //!< ratio progression of a sliding eproperty::Value<bool> propertyCloseOutEvent; //!< ratio progression of a sliding
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _shaperName Shaper file properties * @param _shaperName Shaper file properties
*/ */
PopUp(); PopUp();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(PopUp, "PopUp"); DECLARE_WIDGET_FACTORY(PopUp, "PopUp");
/** /**
* @brief Destructor * Destructor
*/ */
~PopUp(); ~PopUp();
protected: protected:

View File

@ -15,7 +15,7 @@ namespace ewol {
using Select = ememory::Ptr<ewol::widget::Select>; using Select = ememory::Ptr<ewol::widget::Select>;
using SelectWeak = ememory::WeakPtr<ewol::widget::Select>; using SelectWeak = ememory::WeakPtr<ewol::widget::Select>;
/** /**
* @brief a composed Select is a Select with an inside composed with the specify XML element * a composed Select is a Select with an inside composed with the specify XML element
* ==> this permit to generate standard element simple * ==> this permit to generate standard element simple
*/ */
class Select : public ewol::widget::SpinBase { class Select : public ewol::widget::SpinBase {
@ -25,14 +25,14 @@ namespace ewol {
eproperty::Value<int> propertyValue; //!< Current state of the Select. eproperty::Value<int> propertyValue; //!< Current state of the Select.
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _shaperName Shaper file properties * @param _shaperName Shaper file properties
*/ */
Select(); Select();
public: public:
DECLARE_WIDGET_FACTORY(Select, "Select"); DECLARE_WIDGET_FACTORY(Select, "Select");
/** /**
* @brief Destructor * Destructor
*/ */
~Select(); ~Select();
protected: protected:

View File

@ -15,7 +15,7 @@ namespace ewol {
using Spin = ememory::Ptr<ewol::widget::Spin>; using Spin = ememory::Ptr<ewol::widget::Spin>;
using SpinWeak = ememory::WeakPtr<ewol::widget::Spin>; using SpinWeak = ememory::WeakPtr<ewol::widget::Spin>;
/** /**
* @brief a composed Spin is a Spin with an inside composed with the specify XML element * a composed Spin is a Spin with an inside composed with the specify XML element
* ==> this permit to generate standard element simple * ==> this permit to generate standard element simple
*/ */
class Spin : public ewol::widget::SpinBase { class Spin : public ewol::widget::SpinBase {
@ -31,15 +31,15 @@ namespace ewol {
eproperty::Value<int8_t> propertyMantis; //!< number of value under '.' value eproperty::Value<int8_t> propertyMantis; //!< number of value under '.' value
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _mode mode to display the spin * @param _mode mode to display the spin
* @param[in] _shaperName Shaper file properties * @param _shaperName Shaper file properties
*/ */
Spin(); Spin();
public: public:
DECLARE_WIDGET_FACTORY(Spin, "Spin"); DECLARE_WIDGET_FACTORY(Spin, "Spin");
/** /**
* @brief Destructor * Destructor
*/ */
~Spin(); ~Spin();
protected: protected:

View File

@ -34,17 +34,17 @@ namespace ewol {
~TreeView(); ~TreeView();
protected: protected:
/** /**
* @brief Calculate an element size to extimate the render size. * Calculate an element size to extimate the render size.
* @note Does not generate the with the same size. * @note Does not generate the with the same size.
* @param[in] _pos Position of colomn and Raw of the element. * @param _pos Position of colomn and Raw of the element.
* @return The estimate size of the element. * @return The estimate size of the element.
*/ */
Vector2f calculateElementSize( Vector2i _pos) ; Vector2f calculateElementSize( Vector2i _pos) ;
/** /**
* @brief Draw an element in the specific size and position. * Draw an element in the specific size and position.
* @param[in] _pos Position of colomn and Raw of the element. * @param _pos Position of colomn and Raw of the element.
* @param[in] _start Start display position. * @param _start Start display position.
* @param[in] _size Render raw size * @param _size Render raw size
* @return The estimate size of the element. * @return The estimate size of the element.
*/ */
void drawElement( Vector2i _pos, Vector2f _start, Vector2f _size) ; void drawElement( Vector2i _pos, Vector2f _start, Vector2f _size) ;

View File

@ -45,24 +45,24 @@ namespace ewol {
float this.slidingProgress; //!< ratio progression of a sliding float this.slidingProgress; //!< ratio progression of a sliding
protected: protected:
/** /**
* @brief Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...) * Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...)
* @param[in] _id Id in the vector * @param _id Id in the vector
*/ */
void subWidgetSelectSetVectorId(int _id); void subWidgetSelectSetVectorId(int _id);
public: public:
/** /**
* @brief Select a new subwidget to display * Select a new subwidget to display
* @param[in] _id Id of the subwidget requested * @param _id Id of the subwidget requested
*/ */
void subWidgetSelectSet(int _id); void subWidgetSelectSet(int _id);
/** /**
* @brief Select a new subwidget to display * Select a new subwidget to display
* @param[in] _widgetPointer Pointer on the widget selected (must be added before) * @param _widgetPointer Pointer on the widget selected (must be added before)
*/ */
void subWidgetSelectSet( Widget _widgetPointer); void subWidgetSelectSet( Widget _widgetPointer);
/** /**
* @brief Select a new subwidget to display * Select a new subwidget to display
* @param[in] _widgetName Name of the subwidget name * @param _widgetName Name of the subwidget name
*/ */
void subWidgetSelectSet( String _widgetName); void subWidgetSelectSet( String _widgetName);
public: public:
@ -73,8 +73,8 @@ namespace ewol {
protected: protected:
esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed
/** /**
* @brief Periodic call to update grapgic display * Periodic call to update grapgic display
* @param[in] _event Time generic event * @param _event Time generic event
*/ */
void periodicCall( ewol::event::Time _event); void periodicCall( ewol::event::Time _event);
protected: protected:

View File

@ -19,7 +19,7 @@ namespace ewol {
using WidgetScrolled = ememory::Ptr<ewol::widget::WidgetScrolled>; using WidgetScrolled = ememory::Ptr<ewol::widget::WidgetScrolled>;
using WidgetScrolledWeak = ememory::WeakPtr<ewol::widget::WidgetScrolled>; using WidgetScrolledWeak = ememory::WeakPtr<ewol::widget::WidgetScrolled>;
/** /**
* @brief Widget to integrate a scrool bar in a widget. This is not a stadalone widget. * Widget to integrate a scrool bar in a widget. This is not a stadalone widget.
*/ */
class WidgetScrolled : public Widget { class WidgetScrolled : public Widget {
public: // properties: public: // properties:
@ -50,12 +50,12 @@ namespace ewol {
boolean this.singleFingerMode; //!< in many case the moving in a subwidget is done with one finger, it is enought ==> the user select... boolean this.singleFingerMode; //!< in many case the moving in a subwidget is done with one finger, it is enought ==> the user select...
public: public:
/** /**
* @brief Set the single finger capabilities/ * Set the single finger capabilities/
* @param[in] _status True if single inger mode, two otherwise/ * @param _status True if single inger mode, two otherwise/
*/ */
void setSingleFinger(boolean _status); void setSingleFinger(boolean _status);
/** /**
* @brief Get the single finger capabilities * Get the single finger capabilities
* @return true The single finger mode is active * @return true The single finger mode is active
* @return false The To finger mode is active * @return false The To finger mode is active
*/ */
@ -63,7 +63,7 @@ namespace ewol {
return this.singleFingerMode; return this.singleFingerMode;
} }
/** /**
* @brief Reset the scoll of the subWidget * Reset the scoll of the subWidget
*/ */
void resetScrollOrigin() { void resetScrollOrigin() {
this.originScrooled = Vector2f(0,0); this.originScrooled = Vector2f(0,0);
@ -74,15 +74,15 @@ namespace ewol {
Vector2f this.fingerMoveStartPos[CALCULATE_SIMULTANEOUS_FINGER]; Vector2f this.fingerMoveStartPos[CALCULATE_SIMULTANEOUS_FINGER];
protected: protected:
/** /**
* @brief Scroll Widget main ructor to be herited from an other widget (this is not a stand-alone widget) * Scroll Widget main ructor to be herited from an other widget (this is not a stand-alone widget)
* @param[in] _shaperName Shaper name if the scrolled widget. * @param _shaperName Shaper name if the scrolled widget.
*/ */
WidgetScrolled(); WidgetScrolled();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(WidgetScrolled, "WidgetScrolled"); DECLARE_WIDGET_FACTORY(WidgetScrolled, "WidgetScrolled");
/** /**
* @brief Scroll widget destructor. * Scroll widget destructor.
*/ */
~WidgetScrolled(); ~WidgetScrolled();
protected: protected:
@ -93,42 +93,42 @@ namespace ewol {
void systemDraw( ewol::DrawProperty _displayProp) ; void systemDraw( ewol::DrawProperty _displayProp) ;
protected: protected:
/** /**
* @brief For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled * For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled
* @param[in] _nbPixel number of pixel scrolling * @param _nbPixel number of pixel scrolling
*/ */
void setScrollingSize(float _nbPixel) { void setScrollingSize(float _nbPixel) {
this.pixelScrolling = _nbPixel; this.pixelScrolling = _nbPixel;
}; };
/** /**
* @brief Specify the mode of scrolling for this windows * Specify the mode of scrolling for this windows
* @param[in] _newMode the selected mode for the scrolling... * @param _newMode the selected mode for the scrolling...
*/ */
void scroolingMode(enum scrollingMode _newMode); void scroolingMode(enum scrollingMode _newMode);
/** /**
* @brief set the specific mawimum size of the widget * set the specific mawimum size of the widget
* @param[in] _localSize new Maximum size * @param _localSize new Maximum size
*/ */
void setMaxSize( Vector2f _localSize) { void setMaxSize( Vector2f _localSize) {
this.maxSize = _localSize; this.maxSize = _localSize;
}; };
/** /**
* @brief Request a specific position for the scrolling of the current windows. * Request a specific position for the scrolling of the current windows.
* @param[in] _borderWidth size of the border that requested the element might not to be * @param _borderWidth size of the border that requested the element might not to be
* @param[in] _currentPosition Position that is requested to view * @param _currentPosition Position that is requested to view
* @param[in] _center True if the position might be at the center of the widget * @param _center True if the position might be at the center of the widget
*/ */
void setScrollingPositionDynamic(Vector2f _borderWidth, Vector2f _currentPosition, boolean _center = false); void setScrollingPositionDynamic(Vector2f _borderWidth, Vector2f _currentPosition, boolean _center = false);
/** /**
* @brief set the scrolling limit when arriving at he end of the widget * set the scrolling limit when arriving at he end of the widget
* @param[in] _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end ... * @param _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end ...
*/ */
void setLimitScrolling(float _poucentageLimit) { void setLimitScrolling(float _poucentageLimit) {
_poucentageLimit = etk::avg(0.1f, _poucentageLimit,1.0f); _poucentageLimit = etk::avg(0.1f, _poucentageLimit,1.0f);
this.limitScrolling = Vector2f(_poucentageLimit, _poucentageLimit); this.limitScrolling = Vector2f(_poucentageLimit, _poucentageLimit);
}; };
/** /**
* @brief set the scrolling limit when arriving at he end of the widget * set the scrolling limit when arriving at he end of the widget
* @param[in] _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end for axis specific... * @param _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end for axis specific...
*/ */
void setLimitScrolling( Vector2f _poucentageLimit) { void setLimitScrolling( Vector2f _poucentageLimit) {
this.limitScrolling = Vector2f(etk::avg(0.1f, _poucentageLimit.x(),1.0f), etk::avg(0.1f, _poucentageLimit.y(),1.0f)); this.limitScrolling = Vector2f(etk::avg(0.1f, _poucentageLimit.x(),1.0f), etk::avg(0.1f, _poucentageLimit.y(),1.0f));

View File

@ -16,7 +16,7 @@ namespace ewol {
using FileChooser = ememory::Ptr<ewol::widget::FileChooser>; using FileChooser = ememory::Ptr<ewol::widget::FileChooser>;
using FileChooserWeak = ememory::WeakPtr<ewol::widget::FileChooser>; using FileChooserWeak = ememory::WeakPtr<ewol::widget::FileChooser>;
/** /**
* @brief File Chooser is a simple selector of file for opening, saving, and what you want ... * File Chooser is a simple selector of file for opening, saving, and what you want ...
* *
* As all other pop-up methode ( wost case we can have) the creating is simple , but event back is not all the time simple: * As all other pop-up methode ( wost case we can have) the creating is simple , but event back is not all the time simple:
* *

View File

@ -76,14 +76,14 @@ namespace ewol {
int this.confIdDownData; int this.confIdDownData;
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _mode The mode to display the elements * @param _mode The mode to display the elements
*/ */
SpinBase(); SpinBase();
void init() ; void init() ;
public: public:
/** /**
* @brief Destructor * Destructor
*/ */
~SpinBase(); ~SpinBase();
protected: protected:

View File

@ -15,7 +15,7 @@ namespace ewol {
using StdPopUp = ememory::Ptr<ewol::widget::StdPopUp>; using StdPopUp = ememory::Ptr<ewol::widget::StdPopUp>;
using StdPopUpWeak = ememory::WeakPtr<ewol::widget::StdPopUp>; using StdPopUpWeak = ememory::WeakPtr<ewol::widget::StdPopUp>;
/** /**
* @brief The std pop up widget is a siple message widget to notify user of some simple things, like: * The std pop up widget is a siple message widget to notify user of some simple things, like:
* *
* [pre] * [pre]
* +---------------------------------+---+---+---+ * +---------------------------------+---+---+---+
@ -44,33 +44,33 @@ namespace ewol {
eproperty::Value<String> propertyComment; //!< comment in the pop-up (can be decorated text) eproperty::Value<String> propertyComment; //!< comment in the pop-up (can be decorated text)
protected: protected:
/** /**
* @brief std-pop-up ructor. * std-pop-up ructor.
*/ */
StdPopUp(); StdPopUp();
void init(); void init();
public: public:
DECLARE_WIDGET_FACTORY(StdPopUp, "StdPopUp"); DECLARE_WIDGET_FACTORY(StdPopUp, "StdPopUp");
/** /**
* @brief std-pop-up destructor. * std-pop-up destructor.
*/ */
~StdPopUp(); ~StdPopUp();
protected: protected:
ewol::widget::Label this.title; //!< Title Label widget ewol::widget::Label this.title; //!< Title Label widget
/** /**
* @brief property callback when request a change of the title. * property callback when request a change of the title.
*/ */
void onChangePropertyTitle(); void onChangePropertyTitle();
ewol::widget::Label this.comment; //!< Comment label widget ewol::widget::Label this.comment; //!< Comment label widget
/** /**
* @brief property callback when request a change of the Comment. * property callback when request a change of the Comment.
*/ */
void onChangePropertyComment(); void onChangePropertyComment();
protected: protected:
ewol::widget::Sizer this.subBar; //!< subwidget bar containing all the button. ewol::widget::Sizer this.subBar; //!< subwidget bar containing all the button.
public: public:
/** /**
* @brief Add a buttom button. * Add a buttom button.
* @param[in] _text Decorated text to diplay in button. * @param _text Decorated text to diplay in button.
*/ */
ewol::widget::Button addButton( String _text, boolean _autoExit=false); ewol::widget::Button addButton( String _text, boolean _autoExit=false);
public: public:

View File

@ -1,7 +1,7 @@
package org.atriasoft.echrono; package org.atriasoft.echrono;
/** /**
* @brief Clock is a compleate virtual clock that is used to virtualize the urrent clock used (can be non real-time, ex:for simulation) * Clock is a compleate virtual clock that is used to virtualize the urrent clock used (can be non real-time, ex:for simulation)
*/ */
public class Clock { public class Clock {
public static Clock now() { public static Clock now() {

View File

@ -1,7 +1,7 @@
package org.atriasoft.echrono; package org.atriasoft.echrono;
/** /**
* @brief Steady is a Program start time clock * Steady is a Program start time clock
*/ */
public class Steady { public class Steady {
public static Steady now() { public static Steady now() {

View File

@ -1,7 +1,7 @@
package org.atriasoft.echrono; package org.atriasoft.echrono;
/** /**
* @brief Represent the earth clock (if computer is synchronized) * Represent the earth clock (if computer is synchronized)
*/ */
public class Time { public class Time {
public static Time now() { public static Time now() {

View File

@ -11,7 +11,7 @@ import org.atriasoft.etk.Uri;
import org.atriasoft.ewol.internal.Log; import org.atriasoft.ewol.internal.Log;
/** /**
* @brief This is a simple interface to converte application display string in a * This is a simple interface to converte application display string in a
* generic current system language * generic current system language
* @note: The current name of language reprenent the file name, then if you want * @note: The current name of language reprenent the file name, then if you want
* to get the machine language in an other than generic passed, juste add * to get the machine language in an other than generic passed, juste add
@ -30,19 +30,19 @@ public class ETranslate {
private static boolean g_isInit = false; private static boolean g_isInit = false;
/** /**
* @brief Initialize etranslate * Initialize etranslate
* @param[in] _argc Number of argument list * @param _argc Number of argument list
* @param[in] _argv List of arguments * @param _argv List of arguments
*/ */
static { static {
} }
/** /**
* @brief Set the path folder of the translation files * Set the path folder of the translation files
* @param[in] _lib Library name that the path depend * @param _lib Library name that the path depend
* @param[in] _uri ETK generic uri (DATA:... or /xxx) * @param _uri ETK generic uri (DATA:... or /xxx)
* @param[in] _major This path is the major path (The last loaded, the one which * @param _major This path is the major path (The last loaded, the one which
* overload all) * overload all)
*/ */
public static void addPath(final String _lib, final Uri _uri) { public static void addPath(final String _lib, final Uri _uri) {
@ -60,7 +60,7 @@ public class ETranslate {
} }
/** /**
* @brief Automatic detection of the system language * Automatic detection of the system language
*/ */
public static void autoDetectLanguage() { public static void autoDetectLanguage() {
if (g_isInit == false) { if (g_isInit == false) {
@ -98,9 +98,9 @@ public class ETranslate {
} }
/** /**
* @brief Translate a specific text (if not find, it will be retured the same * Translate a specific text (if not find, it will be retured the same
* text). * text).
* @param[in] _instance Text to translate. * @param _instance Text to translate.
* @return The tranlated text. * @return The tranlated text.
*/ */
public static String get(final String _instance) { public static String get(final String _instance) {
@ -121,7 +121,7 @@ public class ETranslate {
} }
/** /**
* @brief Get the current language loaded * Get the current language loaded
* @return The 2/3 char defining the language * @return The 2/3 char defining the language
*/ */
public static String getLanguage() { public static String getLanguage() {
@ -129,7 +129,7 @@ public class ETranslate {
} }
/** /**
* @brief Get the current language selected * Get the current language selected
* @return The 2/3 char defining the language * @return The 2/3 char defining the language
*/ */
public static String getLanguageDefault() { public static String getLanguageDefault() {
@ -137,8 +137,8 @@ public class ETranslate {
} }
/** /**
* @brief Get the current paths of the library * Get the current paths of the library
* @param[in] _lib Library name that the path depend * @param _lib Library name that the path depend
* @return Uri value. * @return Uri value.
*/ */
public static Uri getPaths(final String _lib) { public static Uri getPaths(final String _lib) {
@ -225,9 +225,9 @@ public class ETranslate {
} }
/** /**
* @brief Set the language to load data. when no data availlable, we get the * Set the language to load data. when no data availlable, we get the
* default language. * default language.
* @param[in] _lang Language to load : ("EN" for english, "FR" for french, "DE" * @param _lang Language to load : ("EN" for english, "FR" for french, "DE"
* for German, "SP" for spanish ...) * for German, "SP" for spanish ...)
*/ */
public static void setLanguage(final String _lang) { public static void setLanguage(final String _lang) {
@ -263,9 +263,9 @@ public class ETranslate {
} }
/** /**
* @brief Set the default language to load data (the default language might * Set the default language to load data (the default language might
* contain all internal data for the basic application) * contain all internal data for the basic application)
* @param[in] _lang Language to load : ("EN" for english, "FR" for french, "DE" * @param _lang Language to load : ("EN" for english, "FR" for french, "DE"
* for German, "SP" for spanish ...) * for German, "SP" for spanish ...)
*/ */
public static void setLanguageDefault(final String _lang) { public static void setLanguageDefault(final String _lang) {

View File

@ -20,15 +20,15 @@ public class Ewol {
} }
/** /**
* @brief This is the only one things the User might done in his main(); * This is the only one things the User might done in his main();
* @note To answare you before you ask the question, this is really simple: * @note To answare you before you ask the question, this is really simple:
* Due to the fect that the current system is multiple-platform, you "main" * 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 * Does not exist in the android platform, then ewol call other start
* and stop function, to permit to have only one code * and stop function, to permit to have only one code
* @note The main can not be in the ewol, due to the fact thet is an librairy * @note The main can not be in the ewol, due to the fact thet is an librairy
* @param[in] _application just created instance of the applicationo * @param _application just created instance of the applicationo
* @param[in] _argc Standard argc * @param _argc Standard argc
* @param[in] _argv Standard argv * @param _argv Standard argv
* @return normal error int for the application error management * @return normal error int for the application error management
*/ */
public static int run(final EwolApplication _application, String[] _argv); public static int run(final EwolApplication _application, String[] _argv);

View File

@ -8,7 +8,7 @@ package org.atriasoft.ewol;
import org.atriasoft.etk.math.Vector2f; import org.atriasoft.etk.math.Vector2f;
/** /**
* @brief Gravity of the widget property * Gravity of the widget property
*/ */
public enum Gravity { public enum Gravity {
center, // !< gravity is in center center, // !< gravity is in center

View File

@ -35,7 +35,7 @@ public class Padding {
} }
/** /**
* @brief Add a vector to this one * Add a vector to this one
* @param _v The vector to add to this one * @param _v The vector to add to this one
*/ */
public Padding add(final Padding _v) { public Padding add(final Padding _v) {

View File

@ -13,14 +13,14 @@ public abstract class Compositing {
protected Matrix4f matrixApply = Matrix4f.IDENTITY;; protected Matrix4f matrixApply = Matrix4f.IDENTITY;;
/** /**
* @brief clear alll tre registered element in the current element * clear alll tre registered element in the current element
*/ */
public void clear() { public void clear() {
this.matrixApply = Matrix4f.IDENTITY; this.matrixApply = Matrix4f.IDENTITY;
} }
/** /**
* @brief Virtal pure function that request the draw of all openGl elements * Virtal pure function that request the draw of all openGl elements
*/ */
public void draw() { public void draw() {
draw(true); draw(true);
@ -29,39 +29,39 @@ public abstract class Compositing {
public abstract void draw(final boolean _disableDepthTest); public abstract void draw(final boolean _disableDepthTest);
/** /**
* @brief reset to the eye matrix the openGL mouving system * reset to the eye matrix the openGL mouving system
*/ */
public void resetMatrix() { public void resetMatrix() {
this.matrixApply = Matrix4f.IDENTITY; this.matrixApply = Matrix4f.IDENTITY;
} }
/** /**
* @brief rotate the curent display of this element * rotate the curent display of this element
* @param[in] _vect The rotation vector to apply at the transformation matrix * @param _vect The rotation vector to apply at the transformation matrix
*/ */
public void rotate(final Vector3f _vect, final float _angle) { public void rotate(final Vector3f _vect, final float _angle) {
this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixRotate(_vect, _angle)); this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixRotate(_vect, _angle));
} }
/** /**
* @brief scale the current diaplsy of this element * scale the current diaplsy of this element
* @param[in] _vect The scaling vector to apply at the transformation matrix * @param _vect The scaling vector to apply at the transformation matrix
*/ */
public void scale(final Vector3f _vect) { public void scale(final Vector3f _vect) {
this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixScale(_vect)); this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixScale(_vect));
} }
/** /**
* @brief set the transformation matrix * set the transformation matrix
* @param[in] _mat The new matrix. * @param _mat The new matrix.
*/ */
public void setMatrix(final Matrix4f _mat) { public void setMatrix(final Matrix4f _mat) {
this.matrixApply = _mat; this.matrixApply = _mat;
} }
/** /**
* @brief translate the current display of this element * translate the current display of this element
* @param[in] _vect The translation vector to apply at the transformation matrix * @param _vect The translation vector to apply at the transformation matrix
*/ */
public void translate(final Vector3f _vect) { public void translate(final Vector3f _vect) {
this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixTranslate(_vect)); this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixTranslate(_vect));

View File

@ -48,7 +48,7 @@ public class CompositingDrawing extends Compositing {
// internal API for the generation abstraction of triangles // internal API for the generation abstraction of triangles
/** /**
* @brief Basic ructor * Basic ructor
*/ */
public CompositingDrawing() { public CompositingDrawing() {
loadProgram(); loadProgram();
@ -63,7 +63,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief add a point reference at the current position (this is a vertex * add a point reference at the current position (this is a vertex
* reference at the current position * reference at the current position
*/ */
public void addVertex() { public void addVertex() {
@ -72,11 +72,11 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief draw a 2D circle with the specify rafdius parameter. * draw a 2D circle with the specify rafdius parameter.
* @param[in] _radius Distence to the dorder * @param _radius Distence to the dorder
* @param[in] _angleStart start angle of this circle ([0..2PI] otherwithe == > * @param _angleStart start angle of this circle ([0..2PI] otherwithe == >
* disable) * disable)
* @param[in] _angleStop stop angle of this circle ([0..2PI] otherwithe == > * @param _angleStop stop angle of this circle ([0..2PI] otherwithe == >
* disable) * disable)
*/ */
public void circle(final float _radius) { public void circle(final float _radius) {
@ -150,7 +150,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief clear alll tre registered element in the current element * clear alll tre registered element in the current element
*/ */
@Override @Override
public void clear() { public void clear() {
@ -178,7 +178,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief draw All the refistered text in the current element on openGL * draw All the refistered text in the current element on openGL
*/ */
@Override @Override
public void draw(final boolean _disableDepthTest) { public void draw(final boolean _disableDepthTest) {
@ -208,7 +208,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief Lunch the generation of triangle * Lunch the generation of triangle
*/ */
private void generateTriangle() { private void generateTriangle() {
this.triElement = 0; this.triElement = 0;
@ -221,7 +221,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief Get the foreground color of the font. * Get the foreground color of the font.
* @return Foreground color. * @return Foreground color.
*/ */
public Color getColor() { public Color getColor() {
@ -229,7 +229,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief Get the background color of the font. * Get the background color of the font.
* @return Background color. * @return Background color.
*/ */
public Color getColorBg() { public Color getColorBg() {
@ -237,7 +237,7 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief get the current display position (sometime needed in the gui control) * get the current display position (sometime needed in the gui control)
* @return the current position. * @return the current position.
*/ */
public Vector3f getPos() { public Vector3f getPos() {
@ -245,8 +245,8 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief set the Color of the current triangle drawing * set the Color of the current triangle drawing
* @param[in] _color Color to current dots generated * @param _color Color to current dots generated
*/ */
private void internalSetColor(final Color _color) { private void internalSetColor(final Color _color) {
if (this.triElement < 1) { if (this.triElement < 1) {
@ -265,8 +265,8 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief Relative drawing a line (spacial vector) * Relative drawing a line (spacial vector)
* @param[in] _vect Vector of the curent line. * @param _vect Vector of the curent line.
*/ */
public void lineRel(final Vector3f _vect) { public void lineRel(final Vector3f _vect) {
lineTo(this.position.add(_vect)); lineTo(this.position.add(_vect));
@ -277,8 +277,8 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief draw a line to a specific position * draw a line to a specific position
* @param[in] _dest Position of the end of the line. * @param _dest Position of the end of the line.
*/ */
public void lineTo(final Vector3f _dest) { public void lineTo(final Vector3f _dest) {
resetCount(); resetCount();
@ -315,7 +315,7 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief load the openGL program and get all the ID needed * load the openGL program and get all the ID needed
*/ */
private void loadProgram() { private void loadProgram() {
// remove previous loading ... in case // remove previous loading ... in case
@ -337,8 +337,8 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief draw a 2D rectangle to the position requested. * draw a 2D rectangle to the position requested.
* @param[in] _dest Position the the end of the rectangle * @param _dest Position the the end of the rectangle
*/ */
public void rectangle(final Vector3f _dest) { public void rectangle(final Vector3f _dest) {
resetCount(); resetCount();
@ -393,15 +393,15 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief draw a 2D rectangle to the requested size. * draw a 2D rectangle to the requested size.
* @param[in] _size size of the rectangle * @param _size size of the rectangle
*/ */
public void rectangleWidth(final Vector3f _size) { public void rectangleWidth(final Vector3f _size) {
rectangle(this.position.add(_size)); rectangle(this.position.add(_size));
} }
/** /**
* @brief in case of some error the count can be reset * in case of some error the count can be reset
*/ */
private void resetCount() { private void resetCount() {
this.triElement = 0; this.triElement = 0;
@ -412,9 +412,9 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief Request a clipping area for the text (next draw only) * Request a clipping area for the text (next draw only)
* @param[in] _pos Start position of the clipping * @param _pos Start position of the clipping
* @param[in] _posEnd End position of the clipping * @param _posEnd End position of the clipping
*/ */
public void setClipping(final Vector3f _pos, final Vector3f _posEnd) { public void setClipping(final Vector3f _pos, final Vector3f _posEnd) {
// note the internal system all time request to have a bounding all time in the // note the internal system all time request to have a bounding all time in the
@ -425,9 +425,9 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief enable/Disable the clipping (without lose the current clipping * enable/Disable the clipping (without lose the current clipping
* position) * position)
* @brief _newMode The new status of the clipping * _newMode The new status of the clipping
*/ */
public void setClippingMode(final boolean _newMode) { public void setClippingMode(final boolean _newMode) {
this.clippingEnable = _newMode; this.clippingEnable = _newMode;
@ -438,34 +438,34 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief Request a clipping area for the text (next draw only) * Request a clipping area for the text (next draw only)
* @param[in]_ pos Start position of the clipping * @param_ pos Start position of the clipping
* @param[in] _width Width size of the clipping * @param _width Width size of the clipping
*/ */
public void setClippingWidth(final Vector3f _pos, final Vector3f _width) { public void setClippingWidth(final Vector3f _pos, final Vector3f _width) {
setClipping(_pos, _pos.add(_width)); setClipping(_pos, _pos.add(_width));
}; };
/** /**
* @brief set the Color of the current foreground font * set the Color of the current foreground font
* @param[in] _color Color to set on foreground (for next print) * @param _color Color to set on foreground (for next print)
*/ */
public void setColor(final Color _color) { public void setColor(final Color _color) {
this.color = _color; this.color = _color;
}; };
/** /**
* @brief set the background color of the font (for selected Text (not the * set the background color of the font (for selected Text (not the
* global BG)) * global BG))
* @param[in] _color Color to set on background (for next print) * @param _color Color to set on background (for next print)
*/ */
public void setColorBg(final Color _color) { public void setColorBg(final Color _color) {
this.colorBg = _color; this.colorBg = _color;
}; };
/** /**
* @brief internal add of the specific point * internal add of the specific point
* @param[in] _point The requeste dpoint to add * @param _point The requeste dpoint to add
*/ */
private void setPoint(final Vector3f point) { private void setPoint(final Vector3f point) {
this.triangle[this.triElement] = point; this.triangle[this.triElement] = point;
@ -481,8 +481,8 @@ public class CompositingDrawing extends Compositing {
}; };
/** /**
* @brief set position for the next text writen * set position for the next text writen
* @param[in] _pos Position of the text (in 3D) * @param _pos Position of the text (in 3D)
*/ */
public void setPos(final Vector3f _pos) { public void setPos(final Vector3f _pos) {
this.position = _pos; this.position = _pos;
@ -493,16 +493,16 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief set relative position for the next text writen * set relative position for the next text writen
* @param[in] _pos ofset apply of the text (in 3D) * @param _pos ofset apply of the text (in 3D)
*/ */
public void setRelPos(final Vector3f _pos) { public void setRelPos(final Vector3f _pos) {
this.position = this.position.add(_pos); this.position = this.position.add(_pos);
} }
/** /**
* @brief Specify the line thickness for the next elements * Specify the line thickness for the next elements
* @param[in] _thickness The thickness disired for the next print * @param _thickness The thickness disired for the next print
*/ */
public void setThickness(final float _thickness) { public void setThickness(final float _thickness) {
this.thickness = _thickness; this.thickness = _thickness;
@ -513,7 +513,7 @@ public class CompositingDrawing extends Compositing {
} }
/** /**
* @brief Un-Load the openGL program and get all the ID needed * Un-Load the openGL program and get all the ID needed
*/ */
private void unLoadProgram() { private void unLoadProgram() {
this.GLprogram = null; this.GLprogram = null;

View File

@ -49,10 +49,10 @@ class CompositingImage extends Compositing {
private ResourceVirtualBufferObject VBO = null; private ResourceVirtualBufferObject VBO = null;
/** /**
* @brief generic ructor * generic ructor
* @param[in] _uri URI of the file that might be loaded * @param _uri URI of the file that might be loaded
* @param[in] _df enable distance field mode * @param _df enable distance field mode
* @param[in] _size for the image when Verctorial image loading is requested * @param _size for the image when Verctorial image loading is requested
*/ */
public CompositingImage() { public CompositingImage() {
this(new Uri(""), sizeAuto); this(new Uri(""), sizeAuto);
@ -73,7 +73,7 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief clear alll tre registered element in the current element * clear alll tre registered element in the current element
*/ */
@Override @Override
public void clear() { public void clear() {
@ -91,8 +91,8 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief draw All the refistered text in the current element on openGL * draw All the refistered text in the current element on openGL
* @param[in] _disableDepthTest disable the Depth test for display * @param _disableDepthTest disable the Depth test for display
*/ */
@Override @Override
public void draw(final boolean _disableDepthTest) { public void draw(final boolean _disableDepthTest) {
@ -141,7 +141,7 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief get the current display position (sometime needed in the gui control) * get the current display position (sometime needed in the gui control)
* @return the current position. * @return the current position.
*/ */
public Vector3f getPos() { public Vector3f getPos() {
@ -149,7 +149,7 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief get the source image registered size in the file (<0 when multiple size image) * get the source image registered size in the file (<0 when multiple size image)
* @return tre image registered size * @return tre image registered size
*/ */
public Vector2i getRealSize() { public Vector2i getRealSize() {
@ -166,7 +166,7 @@ class CompositingImage extends Compositing {
}; };
/** /**
* @brief Sometimes the user declare an image but not allocate the ressources all the time, this is to know it .. * 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. * @return the validity od the resources.
*/ */
public boolean hasSources() { public boolean hasSources() {
@ -174,7 +174,7 @@ class CompositingImage extends Compositing {
}; };
/** /**
* @brief load the openGL program and get all the ID needed * load the openGL program and get all the ID needed
*/ */
private void loadProgram() { private void loadProgram() {
// get the shader resource: // get the shader resource:
@ -194,18 +194,18 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief add a compleate of the image to display with the requested size * add a compleate of the image to display with the requested size
* @param[in] _size size of the output image * @param _size size of the output image
*/ */
public void print(final Vector2i _size) { public void print(final Vector2i _size) {
print(new Vector2f(_size.x(), _size.y())); print(new Vector2f(_size.x(), _size.y()));
}; };
/** /**
* @brief add a part of the image to display with the requested size * add a part of the image to display with the requested size
* @param[in] _size size of the output image * @param _size size of the output image
* @param[in] _sourcePosStart Start position in the image [0..1] (can be bigger but this repeate the image). * @param _sourcePosStart Start position in the image [0..1] (can be bigger but this repeate the image).
* @param[in] _sourcePosStop Stop position in the image [0..1] (can be bigger but this repeate the image). * @param _sourcePosStop Stop position in the image [0..1] (can be bigger but this repeate the image).
*/ */
public void printPart(final Vector2f _size, final Vector2f _sourcePosStart, final Vector2f _sourcePosStop) { public void printPart(final Vector2f _size, final Vector2f _sourcePosStart, final Vector2f _sourcePosStop) {
if (this.resource == null) { if (this.resource == null) {
@ -338,8 +338,8 @@ class CompositingImage extends Compositing {
}; };
/** /**
* @brief set a unique rotation of this element (not set in the rotate Generic system) * set a unique rotation of this element (not set in the rotate Generic system)
* @param[in] _angle Angle to set in radiant. * @param _angle Angle to set in radiant.
*/ */
public void setAngle(final float _angleRad) { public void setAngle(final float _angleRad) {
this.angle = _angleRad; this.angle = _angleRad;
@ -350,9 +350,9 @@ class CompositingImage extends Compositing {
}; };
/** /**
* @brief Request a clipping area for the text (next draw only) * Request a clipping area for the text (next draw only)
* @param[in] _pos Start position of the clipping * @param _pos Start position of the clipping
* @param[in] _posEnd End position of the clipping * @param _posEnd End position of the clipping
*/ */
public void setClipping(final Vector3f _pos, final Vector3f _posEnd) { public void setClipping(final Vector3f _pos, final Vector3f _posEnd) {
this.clippingPosStart = FMath.min(_pos, _posEnd); this.clippingPosStart = FMath.min(_pos, _posEnd);
@ -361,8 +361,8 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief enable/Disable the clipping (without lose the current clipping position) * enable/Disable the clipping (without lose the current clipping position)
* @brief _newMode The new status of the clipping * _newMode The new status of the clipping
*/ */
public void setClippingMode(final boolean _newMode) { public void setClippingMode(final boolean _newMode) {
this.clippingEnable = _newMode; this.clippingEnable = _newMode;
@ -373,17 +373,17 @@ class CompositingImage extends Compositing {
}; };
/** /**
* @brief Request a clipping area for the text (next draw only) * Request a clipping area for the text (next draw only)
* @param[in] _pos Start position of the clipping * @param _pos Start position of the clipping
* @param[in] _width Width size of the clipping * @param _width Width size of the clipping
*/ */
public void setClippingWidth(final Vector3f _pos, final Vector3f _width) { public void setClippingWidth(final Vector3f _pos, final Vector3f _width) {
setClipping(_pos, _pos.add(_width)); setClipping(_pos, _pos.add(_width));
} }
/** /**
* @brief set the Color of the current foreground font * set the Color of the current foreground font
* @param[in] _color Color to set on foreground (for next print) * @param _color Color to set on foreground (for next print)
*/ */
public void setColor(final Color _color) { public void setColor(final Color _color) {
this.color = _color; this.color = _color;
@ -394,8 +394,8 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief set position for the next text writen * set position for the next text writen
* @param[in] _pos Position of the text (in 3D) * @param _pos Position of the text (in 3D)
*/ */
public void setPos(final Vector3f _pos) { public void setPos(final Vector3f _pos) {
this.position = _pos; this.position = _pos;
@ -406,8 +406,8 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief set relative position for the next text writen * set relative position for the next text writen
* @param[in] _pos ofset apply of the text (in 3D) * @param _pos ofset apply of the text (in 3D)
*/ */
public void setRelPos(final Vector3f _pos) { public void setRelPos(final Vector3f _pos) {
this.position.add(_pos); this.position.add(_pos);
@ -422,9 +422,9 @@ class CompositingImage extends Compositing {
} }
/** /**
* @brief change the image Source == > can not be done to display 2 images at the same time ... * change the image Source == > can not be done to display 2 images at the same time ...
* @param[in] _uri New file of the Image * @param _uri New file of the Image
* @param[in] _size for the image when Verctorial image loading is requested * @param _size for the image when Verctorial image loading is requested
*/ */
public void setSource(final Uri _uri) { public void setSource(final Uri _uri) {
setSource(_uri, 32); setSource(_uri, 32);

View File

@ -30,9 +30,9 @@ class Text extends TextBase {
protected float size; protected float size;
/** /**
* @brief generic ructor * generic ructor
* @param[in] _fontName Name of the font that might be loaded * @param _fontName Name of the font that might be loaded
* @param[in] _fontSize size of the font that might be loaded * @param _fontSize size of the font that might be loaded
*/ */
public Text() { public Text() {
this(""); this("");

View File

@ -84,7 +84,7 @@ public abstract class TextBase extends Compositing {
public TextDecoration htmlDecoTmp = new TextDecoration(); // !< current decoration public TextDecoration htmlDecoTmp = new TextDecoration(); // !< current decoration
/** /**
* @brief generic constructor * generic constructor
*/ */
public TextBase() { public TextBase() {
this(new Uri("DATA", "text.vert", "ewol"), new Uri("DATA", "text.frag", "ewol")); this(new Uri("DATA", "text.vert", "ewol"), new Uri("DATA", "text.frag", "ewol"));
@ -109,8 +109,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief calculate a theoric charcode size * calculate a theoric charcode size
* @param[in] _charcode The Unicode value to calculate dimention. * @param _charcode The Unicode value to calculate dimention.
* @return The theoric size used. * @return The theoric size used.
*/ */
public Vector3f calculateSize(final Character _charcode) { public Vector3f calculateSize(final Character _charcode) {
@ -118,8 +118,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief calculate a theoric text size * calculate a theoric text size
* @param[in] _text The string to calculate dimention. * @param _text The string to calculate dimention.
* @return The theoric size used. * @return The theoric size used.
*/ */
public Vector3f calculateSize(final String _text) { public Vector3f calculateSize(final String _text) {
@ -138,8 +138,8 @@ public abstract class TextBase extends Compositing {
public abstract Vector3f calculateSizeChar(Character _charcode); public abstract Vector3f calculateSizeChar(Character _charcode);
/** /**
* @brief calculate a theoric text size * calculate a theoric text size
* @param[in] _text The string to calculate dimention. * @param _text The string to calculate dimention.
* @return The theoric size used. * @return The theoric size used.
*/ */
public Vector3f calculateSizeDecorated(final String _text) { public Vector3f calculateSizeDecorated(final String _text) {
@ -155,8 +155,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief calculate a theoric text size * calculate a theoric text size
* @param[in] _text The string to calculate dimention. * @param _text The string to calculate dimention.
* @return The theoric size used. * @return The theoric size used.
*/ */
public Vector3f calculateSizeHTML(final String _text) { public Vector3f calculateSizeHTML(final String _text) {
@ -187,7 +187,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief clear all the registered element in the current element * clear all the registered element in the current element
*/ */
@Override @Override
public void clear() { public void clear() {
@ -202,14 +202,14 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief disable the alignement system * disable the alignement system
*/ */
public void disableAlignement() { public void disableAlignement() {
this.alignement = AligneMode.alignDisable; this.alignement = AligneMode.alignDisable;
} }
/** /**
* @brief remove the cursor display * remove the cursor display
*/ */
public void disableCursor() { public void disableCursor() {
this.selectionStartPos = -100; this.selectionStartPos = -100;
@ -217,7 +217,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief draw All the registered text in the current element on openGL * draw All the registered text in the current element on openGL
*/ */
@Override @Override
public void draw(final boolean _disableDepthTest) { public void draw(final boolean _disableDepthTest) {
@ -230,7 +230,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief draw All the refistered text in the current element on openGL * draw All the refistered text in the current element on openGL
*/ */
public abstract void drawD(final boolean _disableDepthTest);; public abstract void drawD(final boolean _disableDepthTest);;
@ -238,13 +238,13 @@ public abstract class TextBase extends Compositing {
public abstract void drawMT(final Matrix4f _transformationMatrix, final boolean _enableDepthTest); public abstract void drawMT(final Matrix4f _transformationMatrix, final boolean _enableDepthTest);
/** /**
* @brief calculate the element number that is the first out the alignement * calculate the element number that is the first out the alignement
* range (start at the specify ID, and use start pos with current one) * range (start at the specify ID, and use start pos with current one)
* @param[in] _text The string that might be parsed. * @param _text The string that might be parsed.
* @param[in] _start The first elemnt that might be used to calculate. * @param _start The first elemnt that might be used to calculate.
* @param[out] _stop The last Id availlable in the current string. * @param _stop The last Id availlable in the current string.
* @param[out] _space Number of space in the string. * @param _space Number of space in the string.
* @param[out] _freespace This represent the number of pixel present in the * @param _freespace This represent the number of pixel present in the
* right white space. * right white space.
* @return true if the rifht has free space that can be use for jystify. * @return true if the rifht has free space that can be use for jystify.
* @return false if we find '\n' * @return false if we find '\n'
@ -308,7 +308,7 @@ public abstract class TextBase extends Compositing {
}; };
/** /**
* @brief This generate the line return == > it return to the alignement * This generate the line return == > it return to the alignement
* position start and at the correct line position ==> it might be use to * position start and at the correct line position ==> it might be use to
* not know the line height * not know the line height
*/ */
@ -318,7 +318,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief get the current alignement property * get the current alignement property
* @return the curent alignement type * @return the curent alignement type
*/ */
public AligneMode getAlignement() { public AligneMode getAlignement() {
@ -326,7 +326,7 @@ public abstract class TextBase extends Compositing {
}; };
/** /**
* @brief get the current font mode * get the current font mode
* @return The font mode applied * @return The font mode applied
*/ */
public FontMode getFontMode() { public FontMode getFontMode() {
@ -338,7 +338,7 @@ public abstract class TextBase extends Compositing {
public abstract float getHeight();; public abstract float getHeight();;
/** /**
* @brief get the current display position (sometime needed in the gui control) * get the current display position (sometime needed in the gui control)
* @return the current position. * @return the current position.
*/ */
public Vector3f getPos() { public Vector3f getPos() {
@ -348,8 +348,8 @@ public abstract class TextBase extends Compositing {
public abstract float getSize(); public abstract float getSize();
/** /**
* @brief add a line with the current this.htmlDecoTmp decoration * add a line with the current this.htmlDecoTmp decoration
* @param[in] _data The cuurent data to add. * @param _data The cuurent data to add.
*/ */
public void htmlAddData(final String _data) { public void htmlAddData(final String _data) {
if (this.htmlCurrrentLine.length() > 0 if (this.htmlCurrrentLine.length() > 0
@ -369,7 +369,7 @@ public abstract class TextBase extends Compositing {
}; };
/** /**
* @brief draw the current line * draw the current line
*/ */
public void htmlFlush() { public void htmlFlush() {
if (this.htmlCurrrentLine.length() > 0) { if (this.htmlCurrrentLine.length() > 0) {
@ -380,7 +380,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief load the openGL program and get all the ID needed * load the openGL program and get all the ID needed
*/ */
public void loadProgram(final Uri _vertexShader, final Uri _fragmentShader) { public void loadProgram(final Uri _vertexShader, final Uri _fragmentShader) {
ResourceProgram old = this.GLprogram; ResourceProgram old = this.GLprogram;
@ -401,9 +401,9 @@ public abstract class TextBase extends Compositing {
}; };
/** /**
* @brief This parse a tinyXML node (void pointer to permit to hide tiny XML in * This parse a tinyXML node (void pointer to permit to hide tiny XML in
* include). * include).
* @param[in] _element the exml element. * @param _element the exml element.
*/ */
public void parseHtmlNode(final XmlElement _element) { public void parseHtmlNode(final XmlElement _element) {
for (XmlNode it : _element.getNodes()) { for (XmlNode it : _element.getNodes()) {
@ -514,8 +514,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief display a compleat string in the current element. * display a compleat string in the current element.
* @param[in] _text The string to display. * @param _text The string to display.
*/ */
public void print(final String _text) { public void print(final String _text) {
List<TextDecoration> decorationEmpty = new ArrayList<>(); List<TextDecoration> decorationEmpty = new ArrayList<>();
@ -523,10 +523,10 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief display a compleat string in the current element whith specific * display a compleat string in the current element whith specific
* decorations (advence mode). * decorations (advence mode).
* @param[in] _text The string to display. * @param _text The string to display.
* @param[in] _decoration The text decoration for the text that might be display * @param _decoration The text decoration for the text that might be display
* (if the vector is smaller, the last parameter is get) * (if the vector is smaller, the last parameter is get)
*/ */
public void print(final String _text, final List<TextDecoration> _decoration) { public void print(final String _text, final List<TextDecoration> _decoration) {
@ -705,16 +705,16 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief display the current char in the current element (note that the kerning * display the current char in the current element (note that the kerning
* is availlable if the position is not changed) * is availlable if the position is not changed)
* @param[in] _charcode Char that might be dispalyed * @param _charcode Char that might be dispalyed
*/ */
public abstract void printChar(Character _charcode); public abstract void printChar(Character _charcode);
/** /**
* @brief draw a cursor at the specify position * draw a cursor at the specify position
* @param[in] _isInsertMode True if the insert mode is activated * @param _isInsertMode True if the insert mode is activated
* @param[in] _cursorSize The sizae of the cursor that might be set when insert * @param _cursorSize The sizae of the cursor that might be set when insert
* mode is set [default 20] * mode is set [default 20]
*/ */
public void printCursor(final boolean _isInsertMode) { public void printCursor(final boolean _isInsertMode) {
@ -733,7 +733,7 @@ public abstract class TextBase extends Compositing {
}; };
/** /**
* @brief display a compleat string in the current element with the generic * display a compleat string in the current element with the generic
* decoration specification. (basic html data) * decoration specification. (basic html data)
* *
* [code style=xml] <br/> * [code style=xml] <br/>
@ -757,7 +757,7 @@ public abstract class TextBase extends Compositing {
* *
* @note This is parsed with tiny xml, then be carfull that the XML is correct, * @note This is parsed with tiny xml, then be carfull that the XML is correct,
* and all balises are closed ... otherwite the display can not be done * and all balises are closed ... otherwite the display can not be done
* @param[in] _text The string to display. * @param _text The string to display.
* @TODO : implementation not done .... * @TODO : implementation not done ....
*/ */
public void printDecorated(final String _text) { public void printDecorated(final String _text) {
@ -769,7 +769,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief display a compleat string in the current element with the generic * display a compleat string in the current element with the generic
* decoration specification. (basic html data) * decoration specification. (basic html data)
* *
* [code style=xml] <html> <body> <br/> * [code style=xml] <html> <body> <br/>
@ -793,7 +793,7 @@ public abstract class TextBase extends Compositing {
* *
* @note This is parsed with tiny xml, then be carfull that the XML is correct, * @note This is parsed with tiny xml, then be carfull that the XML is correct,
* and all balises are closed ... otherwite the display can not be done * and all balises are closed ... otherwite the display can not be done
* @param[in] _text The string to display. * @param _text The string to display.
* @TODO : implementation not done .... * @TODO : implementation not done ....
*/ */
public void printHTML(final String _text) { public void printHTML(final String _text) {
@ -828,7 +828,7 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief clear all the intermediate result detween 2 prints * clear all the intermediate result detween 2 prints
*/ */
public void reset() { public void reset() {
this.position = Vector3f.ZERO; this.position = Vector3f.ZERO;
@ -871,9 +871,9 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief Request a clipping area for the text (next draw only) * Request a clipping area for the text (next draw only)
* @param[in] _pos Start position of the clipping * @param _pos Start position of the clipping
* @param[in] _posEnd End position of the clipping * @param _posEnd End position of the clipping
*/ */
public void setClipping(final Vector3f _pos, final Vector3f _posEnd) { public void setClipping(final Vector3f _pos, final Vector3f _posEnd) {
// note the internal system all time request to have a bounding all time in the // note the internal system all time request to have a bounding all time in the
@ -886,9 +886,9 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief enable/Disable the clipping (without lose the current clipping * enable/Disable the clipping (without lose the current clipping
* position) * position)
* @brief _newMode The new status of the clipping * _newMode The new status of the clipping
*/ */
// TODO : Rename setClippingActivity // TODO : Rename setClippingActivity
public void setClippingMode(final boolean _newMode) { public void setClippingMode(final boolean _newMode) {
@ -902,26 +902,26 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief Request a clipping area for the text (next draw only) * Request a clipping area for the text (next draw only)
* @param[in] _pos Start position of the clipping * @param _pos Start position of the clipping
* @param[in] _width Width size of the clipping * @param _width Width size of the clipping
*/ */
public void setClippingWidth(final Vector3f _pos, final Vector3f _width) { public void setClippingWidth(final Vector3f _pos, final Vector3f _width) {
setClipping(_pos, _pos.add(_width)); setClipping(_pos, _pos.add(_width));
} }
/** /**
* @brief set the Color of the current foreground font * set the Color of the current foreground font
* @param[in] _color Color to set on foreground (for next print) * @param _color Color to set on foreground (for next print)
*/ */
public void setColor(final Color _color) { public void setColor(final Color _color) {
this.color = _color; this.color = _color;
} }
/** /**
* @brief set the background color of the font (for selected Text (not the * set the background color of the font (for selected Text (not the
* global BG)) * global BG))
* @param[in] _color Color to set on background (for next print) * @param _color Color to set on background (for next print)
*/ */
public void setColorBg(final Color _color) { public void setColorBg(final Color _color) {
this.colorBg = _color; this.colorBg = _color;
@ -929,16 +929,16 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief change the cursor color * change the cursor color
* @param[in] _color New color for the Selection * @param _color New color for the Selection
*/ */
public void setCursorColor(final Color _color) { public void setCursorColor(final Color _color) {
this.colorCursor = _color; this.colorCursor = _color;
} }
/** /**
* @brief set a cursor at a specific position: * set a cursor at a specific position:
* @param[in] _cursorPos id of the cursor position * @param _cursorPos id of the cursor position
*/ */
public void setCursorPos(final int _cursorPos) { public void setCursorPos(final int _cursorPos) {
this.selectionStartPos = _cursorPos; this.selectionStartPos = _cursorPos;
@ -946,9 +946,9 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief set a cursor at a specific position with his associated selection: * set a cursor at a specific position with his associated selection:
* @param[in] _cursorPos id of the cursor position * @param _cursorPos id of the cursor position
* @param[in] _selectionStartPos id of the starting of the selection * @param _selectionStartPos id of the starting of the selection
*/ */
public void setCursorSelection(final int _cursorPos, final int _selectionStartPos) { public void setCursorSelection(final int _cursorPos, final int _selectionStartPos) {
this.selectionStartPos = _selectionStartPos; this.selectionStartPos = _selectionStartPos;
@ -956,34 +956,34 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief set the default background color of the font (when reset, set this * set the default background color of the font (when reset, set this
* value ...) * value ...)
* @param[in] _color Color to set on background * @param _color Color to set on background
*/ */
public void setDefaultColorBg(final Color _color) { public void setDefaultColorBg(final Color _color) {
this.defaultColorBg = _color; this.defaultColorBg = _color;
} }
/** /**
* @brief set the default Foreground color of the font (when reset, set this * set the default Foreground color of the font (when reset, set this
* value ...) * value ...)
* @param[in] _color Color to set on foreground * @param _color Color to set on foreground
*/ */
public void setDefaultColorFg(final Color _color) { public void setDefaultColorFg(final Color _color) {
this.defaultColorFg = _color; this.defaultColorFg = _color;
} }
/** /**
* @brief Specify the font property (this reset the internal element of the * Specify the font property (this reset the internal element of the
* current text (system requirement) * current text (system requirement)
* @param[in] fontName Current name of the selected font * @param fontName Current name of the selected font
* @param[in] fontSize New font size * @param fontSize New font size
*/ */
public abstract void setFont(final String _fontName, final int _fontSize); public abstract void setFont(final String _fontName, final int _fontSize);
/** /**
* @brief enable or disable the bold mode * enable or disable the bold mode
* @param[in] _status The new status for this display property * @param _status The new status for this display property
*/ */
public void setFontBold(final boolean _status) { public void setFontBold(final boolean _status) {
if (_status == true) { if (_status == true) {
@ -1004,8 +1004,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief enable or disable the italic mode * enable or disable the italic mode
* @param[in] _status The new status for this display property * @param _status The new status for this display property
*/ */
public void setFontItalic(final boolean _status) { public void setFontItalic(final boolean _status) {
if (_status == true) { if (_status == true) {
@ -1026,28 +1026,28 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief Specify the font mode for the next @ref print * Specify the font mode for the next @ref print
* @param[in] mode The font mode requested * @param mode The font mode requested
*/ */
public abstract void setFontMode(FontMode _mode);; public abstract void setFontMode(FontMode _mode);;
/** /**
* @brief Specify the font name (this reset the internal element of the current * Specify the font name (this reset the internal element of the current
* text (system requirement) * text (system requirement)
* @param[in] _fontName Current name of the selected font * @param _fontName Current name of the selected font
*/ */
public abstract void setFontName(final String _fontName); public abstract void setFontName(final String _fontName);
/** /**
* @brief Specify the font size (this reset the internal element of the current * Specify the font size (this reset the internal element of the current
* text (system requirement) * text (system requirement)
* @param[in] _fontSize New font size * @param _fontSize New font size
*/ */
public abstract void setFontSize(final int _fontSize); public abstract void setFontSize(final int _fontSize);
/** /**
* @brief set the activation of the Kerning for the display (if it existed) * set the activation of the Kerning for the display (if it existed)
* @param[in] _newMode enable/Diasable the kerning on this font. * @param _newMode enable/Diasable the kerning on this font.
*/ */
public void setKerningMode(final boolean _newMode) { public void setKerningMode(final boolean _newMode) {
this.kerning = _newMode; this.kerning = _newMode;
@ -1059,8 +1059,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief set position for the next text writen * set position for the next text writen
* @param[in] _pos Position of the text (in 3D) * @param _pos Position of the text (in 3D)
*/ */
public void setPos(final Vector3f _pos) { public void setPos(final Vector3f _pos) {
// check min max for display area // check min max for display area
@ -1091,8 +1091,8 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief set relative position for the next text written * set relative position for the next text written
* @param[in] _pos offset apply of the text (in 3D) * @param _pos offset apply of the text (in 3D)
*/ */
public void setRelPos(final Vector3f _pos) { public void setRelPos(final Vector3f _pos) {
this.position = this.position.add(_pos); this.position = this.position.add(_pos);
@ -1101,18 +1101,18 @@ public abstract class TextBase extends Compositing {
} }
/** /**
* @brief change the selection color * change the selection color
* @param[in] _color New color for the Selection * @param _color New color for the Selection
*/ */
public void setSelectionColor(final Color _color) { public void setSelectionColor(final Color _color) {
this.colorSelection = _color; this.colorSelection = _color;
} }
/** /**
* @brief This generate the possibility to generate the big text property * This generate the possibility to generate the big text property
* @param[in] _startTextpos The x text start position of the display. * @param _startTextpos The x text start position of the display.
* @param[in] _stopTextPos The x text stop position of the display. * @param _stopTextPos The x text stop position of the display.
* @param[in] _alignement mode of alignement for the Text. * @param _alignement mode of alignement for the Text.
* @note The text align in center change of line every display done (even if it * @note The text align in center change of line every display done (even if it
* was just a char) * was just a char)
*/ */

View File

@ -21,7 +21,7 @@ public class ConfigFont {
public ConfigFont() {} public ConfigFont() {}
/** /**
* @brief get the default font folder. * get the default font folder.
* @return The default font folder. * @return The default font folder.
*/ */
public Uri getFolder() { public Uri getFolder() {
@ -29,7 +29,7 @@ public class ConfigFont {
} }
/** /**
* @brief get the current default font name * get the current default font name
* @return a reference on the font name string * @return a reference on the font name string
*/ */
public String getName() { public String getName() {
@ -37,7 +37,7 @@ public class ConfigFont {
} }
/** /**
* @brief get the default font size. * get the default font size.
* @return the font size. * @return the font size.
*/ */
public int getSize() { public int getSize() {
@ -45,7 +45,7 @@ public class ConfigFont {
}; };
/** /**
* @brief get the use of internal/external Font * get the use of internal/external Font
* @return true to enable search of internal data. * @return true to enable search of internal data.
*/ */
public boolean getUseExternal() { public boolean getUseExternal() {
@ -53,9 +53,9 @@ public class ConfigFont {
} }
/** /**
* @brief set the defaut font for all the widgets and basics display. * set the defaut font for all the widgets and basics display.
* @param[in] _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". * @param _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica".
* @param[in] _size The default size of the font default=10. * @param _size The default size of the font default=10.
*/ */
public void set(final String _fontName, final int _size) { public void set(final String _fontName, final int _size) {
this.name = _fontName; this.name = _fontName;
@ -64,16 +64,16 @@ public class ConfigFont {
}; };
/** /**
* @brief Specify the default font folder for the Ewol search system (only needed when embended font) * Specify the default font folder for the Ewol search system (only needed when embended font)
* @param[in] _folder basic folder of the font (ex: DATA:fonts) * @param _folder basic folder of the font (ex: DATA:fonts)
*/ */
public void setFolder(final Uri _folder) { public void setFolder(final Uri _folder) {
this.folder = _folder; this.folder = _folder;
} }
/** /**
* @brief Set the current default font name * Set the current default font name
* @param[in] _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". * @param _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica".
*/ */
public void setName(final String _fontName) { public void setName(final String _fontName) {
this.name = _fontName; this.name = _fontName;
@ -81,8 +81,8 @@ public class ConfigFont {
} }
/** /**
* @brief Set the default font size. * Set the default font size.
* @param[in] _size new font size. * @param _size new font size.
*/ */
public void setSize(final int _size) { public void setSize(final int _size) {
this.size = _size; this.size = _size;
@ -90,8 +90,8 @@ public class ConfigFont {
}; };
/** /**
* @brief set use of internal/external Font * set use of internal/external Font
* @param[in] _val true to enable search of internal data. * @param _val true to enable search of internal data.
*/ */
public void setUseExternal(final boolean _val) { public void setUseExternal(final boolean _val) {
this.useExternal = _val; this.useExternal = _val;

View File

@ -8,46 +8,46 @@ package org.atriasoft.ewol.context;
public interface EwolApplication { public interface EwolApplication {
/** /**
* @brief The application is created. * The application is created.
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
void onCreate(EwolContext _context); void onCreate(EwolContext _context);
/** /**
* @brief The application is removed (call destructor just adter it.). * The application is removed (call destructor just adter it.).
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
void onDestroy(EwolContext _context); void onDestroy(EwolContext _context);
/** /**
* @brief The user request application removing. * The user request application removing.
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
default void onKillDemand(final EwolContext _context) { default void onKillDemand(final EwolContext _context) {
_context.exit(0); _context.exit(0);
} }
/** /**
* @brief The application is Hide / not visible. * The application is Hide / not visible.
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
void onPause(EwolContext _context); void onPause(EwolContext _context);
/** /**
* @brief The application is resumed (now visible). * The application is resumed (now visible).
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
void onResume(EwolContext _context); void onResume(EwolContext _context);
/** /**
* @brief The application is started. * The application is started.
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
void onStart(EwolContext _context); void onStart(EwolContext _context);
/** /**
* @brief The application is stopped. * The application is stopped.
* @param[in] _context Current ewol context. * @param _context Current ewol context.
*/ */
void onStop(EwolContext _context); void onStop(EwolContext _context);
} }

View File

@ -32,7 +32,7 @@ public abstract class EwolContext extends Application {
private static EwolContext curentInterface = null; private static EwolContext curentInterface = null;
/** /**
* @brief From everyware in the program, we can get the context inteface. * From everyware in the program, we can get the context inteface.
* @return current reference on the instance. * @return current reference on the instance.
*/ */
public static EwolContext getContext() { public static EwolContext getContext() {
@ -40,15 +40,15 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief This is the only one things the User might done in his main(); * This is the only one things the User might done in his main();
* @note : must be implemented in all system OPS implementation * @note : must be implemented in all system OPS implementation
* @note To answare you before you ask the question, this is really simple: Due * @note To answare you before you ask the question, this is really simple: Due
* to the fect that the current system is multiple-platform, you "main" * 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 * Does not exist in the android platform, then ewol call other start and
* stop function, to permit to have only one code * stop function, to permit to have only one code
* @note The main can not be in the ewol, due to the fact thet is an librairy * @note The main can not be in the ewol, due to the fact thet is an librairy
* @param[in] _argc Standard argc * @param _argc Standard argc
* @param[in] _argv Standard argv * @param _argv Standard argv
* @return normal error int for the application error management * @return normal error int for the application error management
*/ */
public static int main(String[] _args); public static int main(String[] _args);
@ -79,7 +79,7 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief Redraw all the windows * Redraw all the windows
*/ */
public void forceRedrawAll() { public void forceRedrawAll() {
if (this.windowsCurrent == null) { if (this.windowsCurrent == null) {
@ -115,7 +115,7 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief get the current windows that is displayed * get the current windows that is displayed
* @return the current handle on the windows (can be null) * @return the current handle on the windows (can be null)
*/ */
public Windows getWindows() { public Windows getWindows() {
@ -123,16 +123,16 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief This fonction lock the pointer properties to move in relative instead * This fonction lock the pointer properties to move in relative instead
* of absolute * of absolute
* @param[in] widget The widget that lock the pointer events * @param widget The widget that lock the pointer events
*/ */
public void inputEventGrabPointer(final Widget _widget) { public void inputEventGrabPointer(final Widget _widget) {
this.input.grabPointer(_widget); this.input.grabPointer(_widget);
} }
/** /**
* @brief This is to transfert the event from one widget to another one * This is to transfert the event from one widget to another one
* @param source the widget where the event came from * @param source the widget where the event came from
* @param destination the widget where the event mitgh be generated now * @param destination the widget where the event mitgh be generated now
*/ */
@ -141,7 +141,7 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief This fonction un-lock the pointer properties to move in relative * This fonction un-lock the pointer properties to move in relative
* instead of absolute * instead of absolute
*/ */
public void inputEventUnGrabPointer() { public void inputEventUnGrabPointer() {
@ -391,7 +391,7 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief Request a display after call a resize * Request a display after call a resize
*/ */
public void requestUpdateSize() { public void requestUpdateSize() {
final Context context = Gale.getContext(); final Context context = Gale.getContext();
@ -399,22 +399,22 @@ public abstract class EwolContext extends Application {
} }
/** /**
* @brief reset event management for the IO like Input ou Mouse or keyborad * reset event management for the IO like Input ou Mouse or keyborad
*/ */
public void resetIOEvent() { public void resetIOEvent() {
this.input.newLayerSet(); this.input.newLayerSet();
} }
/** /**
* @brief Special for init (main) set the start image when loading data * Special for init (main) set the start image when loading data
* @param[in] _fileName Name of the image to load * @param _fileName Name of the image to load
*/ */
public void setInitImage(final Uri _fileName) { public void setInitImage(final Uri _fileName) {
// this.initDisplayImageName = _fileName; // this.initDisplayImageName = _fileName;
} }
/** /**
* @brief set the current windows to display : * set the current windows to display :
* @param _windows Windows that might be displayed * @param _windows Windows that might be displayed
*/ */
public void setWindows(final Windows _windows) { public void setWindows(final Windows _windows) {

View File

@ -20,7 +20,7 @@ import org.atriasoft.gale.key.KeyStatus;
import org.atriasoft.gale.key.KeyType; import org.atriasoft.gale.key.KeyType;
/** /**
* @brief internal structure * internal structure
*/ */
class InputLimit { class InputLimit {
public Duration sepatateTime; public Duration sepatateTime;
@ -88,8 +88,8 @@ class InputManager {
} }
/** /**
* @brief This fonction lock the pointer properties to move in relative instead of absolute * This fonction lock the pointer properties to move in relative instead of absolute
* @param[in] _widget The widget that lock the pointer events * @param _widget The widget that lock the pointer events
*/ */
public void grabPointer(final Widget _widget) { public void grabPointer(final Widget _widget) {
if (_widget == null) { if (_widget == null) {
@ -104,12 +104,12 @@ class InputManager {
} }
/** /**
* @brief generate the event on the destinated widget. * generate the event on the destinated widget.
* @param[in] _type Type of the event that might be sended. * @param _type Type of the event that might be sended.
* @param[in] _destWidget Pointer on the requested widget that element might be sended * @param _destWidget Pointer on the requested widget that element might be sended
* @param[in] _IdInput Id of the event (PC : [0..9] and touch : [1..9]) * @param _IdInput Id of the event (PC : [0..9] and touch : [1..9])
* @param[in] _typeEvent type of the eventg generated * @param _typeEvent type of the eventg generated
* @param[in] _pos position of the event * @param _pos position of the event
* @return true if event has been greped * @return true if event has been greped
*/ */
public boolean localEventInput(final KeyType _type, final Widget _destWidget, final int _IdInput, final KeyStatus _status, final Vector2f _pos) { public boolean localEventInput(final KeyType _type, final Widget _destWidget, final int _IdInput, final KeyStatus _status, final Vector2f _pos) {
@ -128,12 +128,12 @@ class InputManager {
} }
/** /**
* @brief convert the system event id in the correct EWOL id depending of the system management mode * 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 * This function find the next input id unused on the specifiic widget
* == > on PC, the ID does not change (GUI is not the same) * == > on PC, the ID does not change (GUI is not the same)
* @param[in] _type Type of the kay event. * @param _type Type of the kay event.
* @param[in] _destWidget Pointer of the widget destination * @param _destWidget Pointer of the widget destination
* @param[in] _realInputId system Id * @param _realInputId system Id
* @return the ewol input id * @return the ewol input id
*/ */
public int localGetDestinationId(final KeyType _type, final Widget _destWidget, final int _realInputId) { public int localGetDestinationId(final KeyType _type, final Widget _destWidget, final int _realInputId) {
@ -236,7 +236,7 @@ class InputManager {
} }
/** /**
* @brief a new layer on the windows is set == > might remove all the property of the current element ... * a new layer on the windows is set == > might remove all the property of the current element ...
*/ */
public void newLayerSet() { public void newLayerSet() {
for (int iii = 0; iii < MAX_MANAGE_INPUT; iii++) { for (int iii = 0; iii < MAX_MANAGE_INPUT; iii++) {
@ -404,7 +404,7 @@ class InputManager {
} }
/** /**
* @brief This is to transfert the event from one widget to another one * This is to transfert the event from one widget to another one
* @param _source the widget where the event came from * @param _source the widget where the event came from
* @param _destination the widget where the event mitgh be generated now * @param _destination the widget where the event mitgh be generated now
*/ */
@ -440,7 +440,7 @@ class InputManager {
} }
/** /**
* @brief This function un-lock the pointer properties to move in relative instead of absolute * This function un-lock the pointer properties to move in relative instead of absolute
*/ */
public void unGrabPointer() { public void unGrabPointer() {
this.grabWidget = null; this.grabWidget = null;
@ -450,7 +450,7 @@ class InputManager {
}; };
/** /**
* @brief internal structure * internal structure
*/ */
class InputPoperty { class InputPoperty {
public boolean isUsed; public boolean isUsed;

View File

@ -48,7 +48,7 @@ public class EventInput {
}; };
/** /**
* @brief Reset the input property of the curent event. * Reset the input property of the curent event.
*/ */
public void reset() { public void reset() {
// TODO : Call the entry element ant rest it ... // TODO : Call the entry element ant rest it ...

View File

@ -2,8 +2,8 @@ package org.atriasoft.ewol.internal;
public class Tools { public class Tools {
/** /**
* @brief get the next power 2 if the input * get the next power 2 if the input
* @param[in] value Value that we want the next power of 2 * @param value Value that we want the next power of 2
* @return result value * @return result value
*/ */
public static int nextP2(final int _value) { public static int nextP2(final int _value) {

View File

@ -14,14 +14,14 @@ import org.atriasoft.exml.model.XmlElement;
*/ */
/** /**
* @brief Basic message classes for ewol system * Basic message classes for ewol system
* this class permit at every Object to communicate between them. * this class permit at every Object to communicate between them.
*/ */
public class EwolObject { public class EwolObject {
private static Integer valUID = 0; //!< Static used for the unique ID definition private static Integer valUID = 0; //!< Static used for the unique ID definition
/** /**
* @brief get the curent the system inteface. * get the curent the system inteface.
* @return current reference on the instance. * @return current reference on the instance.
*/ */
protected static EwolContext getContext() { protected static EwolContext getContext() {
@ -37,8 +37,8 @@ public class EwolObject {
} }
/** /**
* @brief Retrive an object with his name (in the global list) * Retrive an object with his name (in the global list)
* @param[in] _name Name of the object * @param _name Name of the object
* @return the requested object or null * @return the requested object or null
*/ */
public static EwolObject getObjectNamed(final String _objectName) { public static EwolObject getObjectNamed(final String _objectName) {
@ -60,7 +60,7 @@ public class EwolObject {
private boolean isResource = false; //!< enable this when you want to declare this element is auto-remove private boolean isResource = false; //!< enable this when you want to declare this element is auto-remove
/** /**
* @brief Constructor. * Constructor.
*/ */
public EwolObject() { public EwolObject() {
// note this is nearly atomic ... (but it is enough) // note this is nearly atomic ... (but it is enough)
@ -73,7 +73,7 @@ public class EwolObject {
} }
/** /**
* @brief Auto-destroy the object * Auto-destroy the object
*/ */
protected void autoDestroy() { protected void autoDestroy() {
Log.verbose("Destroy object: [" + getId() + "] type:" + this.getClass().getCanonicalName()); Log.verbose("Destroy object: [" + getId() + "] type:" + this.getClass().getCanonicalName());
@ -89,14 +89,14 @@ public class EwolObject {
} }
/** /**
* @brief Destroy the current object * Destroy the current object
*/ */
public void destroy() { public void destroy() {
autoDestroy(); autoDestroy();
}; };
/** /**
* @brief get the UniqueId of the Object * get the UniqueId of the Object
* @return the requested ID * @return the requested ID
*/ */
public int getId() { public int getId() {
@ -108,8 +108,8 @@ public class EwolObject {
}; };
/** /**
* @brief load attribute properties with an XML node. * load attribute properties with an XML node.
* @param[in] _node Reference on the XML node. * @param _node Reference on the XML node.
* @return true : All has been done corectly. * @return true : All has been done corectly.
* @return false : An error occured. * @return false : An error occured.
*/ */
@ -134,8 +134,8 @@ public class EwolObject {
*/ */
/** /**
* @brief load properties with an XML node. * load properties with an XML node.
* @param[in] _node Reference on the XML node. * @param _node Reference on the XML node.
* @return true : All has been done corectly. * @return true : All has been done corectly.
* @return false : An error occured. * @return false : An error occured.
*/ */
@ -144,7 +144,7 @@ public class EwolObject {
} }
/** /**
* @brief store properties in this XML node. * store properties in this XML node.
* @param[in,out] _node Reference on the XML node. * @param[in,out] _node Reference on the XML node.
* @return true : All has been done corectly. * @return true : All has been done corectly.
* @return false : An error occured. * @return false : An error occured.
@ -163,7 +163,7 @@ public class EwolObject {
*/ */
/** /**
* @brief 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 * 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 * @return true if it might not be removed == > usefull for conficuration class
*/ */
public boolean getStatic() { public boolean getStatic() {
@ -171,7 +171,7 @@ public class EwolObject {
} }
/** /**
* @brief Get the resource status of the element. * Get the resource status of the element.
* @return the resource status. * @return the resource status.
*/ */
public boolean getStatusResource() { public boolean getStatusResource() {
@ -179,8 +179,8 @@ public class EwolObject {
} }
/** /**
* @brief Retrive an object with his name (in the global list) * Retrive an object with his name (in the global list)
* @param[in] _name Name of the object * @param _name Name of the object
* @return the requested object or null * @return the requested object or null
*/ */
public EwolObject getSubObjectNamed(final String _objectName) { public EwolObject getSubObjectNamed(final String _objectName) {
@ -192,7 +192,7 @@ public class EwolObject {
} }
/** /**
* @brief Check if the current objetc his destroy (in removing) * Check if the current objetc his destroy (in removing)
* @return true The object is removed * @return true The object is removed
* @return false The object is not removed * @return false The object is not removed
*/ */
@ -201,15 +201,15 @@ public class EwolObject {
} }
/** /**
* @brief Remove the current parenting. * Remove the current parenting.
*/ */
public void removeParent() { public void removeParent() {
this.parent = null; this.parent = null;
} }
/** /**
* @brief Called by a whild that want to remove pointer of itself from the current list of his parrent * Called by a whild that want to remove pointer of itself from the current list of his parrent
* @param[in] _child Object of the child that want to remove itself * @param _child Object of the child that want to remove itself
*/ */
protected void requestDestroyFromChild(final EwolObject _child) { protected void requestDestroyFromChild(final EwolObject _child) {
Log.info("requestDestroyFromChild(...) is called when an object reference as a parent have a child that request quto-destroy ..."); Log.info("requestDestroyFromChild(...) is called when an object reference as a parent have a child that request quto-destroy ...");
@ -221,8 +221,8 @@ public class EwolObject {
} }
/** /**
* @brief Set the Object has new parrent. * Set the Object has new parrent.
* @param[in] _newParent Object that requesting the parenting * @param _newParent Object that requesting the parenting
*/ */
public void setParent(final EwolObject _newParent) { public void setParent(final EwolObject _newParent) {
// TODO : Implement change of parent ... // TODO : Implement change of parent ...
@ -230,9 +230,9 @@ public class EwolObject {
} }
/** /**
* @brief Declare this element as a resource (or singleton) this mean the element will * 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. * not be auto Remove at the end of the programm. It just notify that it is not removed.
* @param[in] _val Value of the type of the element. * @param _val Value of the type of the element.
*/ */
public void setStatusResource(final boolean _val) { public void setStatusResource(final boolean _val) {
this.isResource = _val; this.isResource = _val;

View File

@ -43,9 +43,9 @@ public class ObjectManager {
} }
/** /**
* @brief Internal API that used only with Object toi reference itself in the manager. * Internal API that used only with Object toi reference itself in the manager.
* @note The manager remove the object when the refecence Low down 1 (last keeper) * @note The manager remove the object when the refecence Low down 1 (last keeper)
* @param[in] _object Reference shared pointer on the object * @param _object Reference shared pointer on the object
*/ */
public synchronized void add(final EwolObject _object) { public synchronized void add(final EwolObject _object) {
if (_object == null) { if (_object == null) {
@ -55,7 +55,7 @@ public class ObjectManager {
} }
/** /**
* @brief clean the weak pointer list (remove weak_ptr that is remoed) * clean the weak pointer list (remove weak_ptr that is remoed)
*/ */
public synchronized void cleanInternalRemoved() { public synchronized void cleanInternalRemoved() {
final int nbObject = this.eObjectList.size(); final int nbObject = this.eObjectList.size();
@ -73,7 +73,7 @@ public class ObjectManager {
} }
/** /**
* @brief Display all object Open. * Display all object Open.
*/ */
public synchronized void displayListObject() { public synchronized void displayListObject() {
Log.info("List loaded object : "); Log.info("List loaded object : ");
@ -86,8 +86,8 @@ public class ObjectManager {
} }
/** /**
* @brief Retrive an Object with his name * Retrive an Object with his name
* @param[in] _name Name of the Object * @param _name Name of the Object
* @return Pointer on the finded Object. * @return Pointer on the finded Object.
*/ */
public synchronized EwolObject get(final String _name) { public synchronized EwolObject get(final String _name) {
@ -104,7 +104,7 @@ public class ObjectManager {
} }
/** /**
* @brief Get the number of loaded object in the system * Get the number of loaded object in the system
* @return number of Object * @return number of Object
*/ */
public synchronized int getNumberObject() { public synchronized int getNumberObject() {
@ -112,8 +112,8 @@ public class ObjectManager {
} }
/** /**
* @brief retrive an object with his name * retrive an object with his name
* @param[in] _name Name of the object * @param _name Name of the object
* @return the requested object or null * @return the requested object or null
*/ */
public synchronized EwolObject getObjectNamed(final String _name) { public synchronized EwolObject getObjectNamed(final String _name) {
@ -121,8 +121,8 @@ public class ObjectManager {
} }
/** /**
* @brief Call every time we can with the current time * Call every time we can with the current time
* @param[in] _localTime Current system Time. * @param _localTime Current system Time.
*/ */
public synchronized void timeCall(final Clock _localTime) { public synchronized void timeCall(final Clock _localTime) {
final Clock previousTime = this.lastPeriodicCallTime; final Clock previousTime = this.lastPeriodicCallTime;
@ -145,15 +145,15 @@ public class ObjectManager {
} }
/** /**
* @brief If the application is suspended The Ewol Object manager does not know it, just call this to update delta call * If the application is suspended The Ewol Object manager does not know it, just call this to update delta call
* @param[in] _localTime Current system Time. * @param _localTime Current system Time.
*/ */
public synchronized void timeCallResume(final Clock _localTime) { public synchronized void timeCallResume(final Clock _localTime) {
this.lastPeriodicCallTime = _localTime; this.lastPeriodicCallTime = _localTime;
} }
/** /**
* @brief remove all resources (un-init) out of the destructor (due to the system implementation) * remove all resources (un-init) out of the destructor (due to the system implementation)
*/ */
public synchronized void unInit() { public synchronized void unInit() {
Log.debug(" == > Un-Init Object-Manager"); Log.debug(" == > Un-Init Object-Manager");
@ -174,16 +174,16 @@ public class ObjectManager {
} }
/** /**
* @brief Add a worker on the system list. * Add a worker on the system list.
* @param[in] _worker Worker to add in the list. * @param _worker Worker to add in the list.
*/ */
public synchronized void workerAdd(final EwolObject _worker) { public synchronized void workerAdd(final EwolObject _worker) {
this.workerList.add(_worker); this.workerList.add(_worker);
} }
/** /**
* @brief Remove a worker on the system list. * Remove a worker on the system list.
* @param[in] _worker Worker to add in the list. * @param _worker Worker to add in the list.
*/ */
public synchronized void workerRemove(final EwolObject _worker) { public synchronized void workerRemove(final EwolObject _worker) {

View File

@ -7,11 +7,11 @@ package org.atriasoft.ewol.object;
*/ */
/** /**
* @brief A worker might not been possesed by someone, then the system might keep a pointer on it. * A worker might not been possesed by someone, then the system might keep a pointer on it.
*/ */
public class Worker extends EwolObject { public class Worker extends EwolObject {
/** /**
* @brief Constructor. * Constructor.
*/ */
public Worker() { public Worker() {
getObjectManager().workerAdd(this); getObjectManager().workerAdd(this);

View File

@ -18,7 +18,7 @@ import org.atriasoft.gale.resource.Resource;
import org.atriasoft.gale.resource.ResourceProgram; import org.atriasoft.gale.resource.ResourceProgram;
/** /**
* @brief simple display of Colored3DObject ==> for DEBUG only Not availlable on * simple display of Colored3DObject ==> for DEBUG only Not availlable on
* ALL platform (like webGL) * ALL platform (like webGL)
*/ */
public class RefactorColored3DObject extends Resource { public class RefactorColored3DObject extends Resource {

View File

@ -30,7 +30,7 @@ class ListElement {
} }
/** /**
* @brief ColorFile is a Resource designed to be specific with the theme (for * ColorFile is a Resource designed to be specific with the theme (for
* example black, or white or orange ...) * example black, or white or orange ...)
*/ */
public class ResourceColorFile extends Resource { public class ResourceColorFile extends Resource {
@ -38,8 +38,8 @@ public class ResourceColorFile extends Resource {
private Color errorColor = Color.ORANGE; private Color errorColor = Color.ORANGE;
/** /**
* @brief Constructor of the color property file * Constructor of the color property file
* @param[in] _uri Name of the file needed * @param _uri Name of the file needed
*/ */
public ResourceColorFile(final Uri _uri) { public ResourceColorFile(final Uri _uri) {
super(_uri.get()); super(_uri.get());
@ -54,8 +54,8 @@ public class ResourceColorFile extends Resource {
} }
/** /**
* @brief Get the associated color of the ID. * Get the associated color of the ID.
* @param[in] _Id Id of the color. * @param _Id Id of the color.
* @return The requested color. * @return The requested color.
*/ */
Color get(final int _id) { Color get(final int _id) {
@ -66,7 +66,7 @@ public class ResourceColorFile extends Resource {
} }
/** /**
* @brief Get All color name * Get All color name
* @return list of all color existing * @return list of all color existing
*/ */
List<String> getColors() { List<String> getColors() {
@ -138,8 +138,8 @@ public class ResourceColorFile extends Resource {
} }
/** /**
* @brief Request the presence of a specific color. * Request the presence of a specific color.
* @param[in] _paramName Name of the color. * @param _paramName Name of the color.
* @return A unique ID of the color (or -1 if an error occured). * @return A unique ID of the color (or -1 if an error occured).
*/ */
public synchronized int request(final String _paramName) { public synchronized int request(final String _paramName) {
@ -154,8 +154,8 @@ public class ResourceColorFile extends Resource {
} }
/** /**
* @brief Set the error color. * Set the error color.
* @param[in] _errorColor Color that might be set when not finding a color * @param _errorColor Color that might be set when not finding a color
*/ */
public void setErrorColor(final Color _errorColor) { public void setErrorColor(final Color _errorColor) {
this.errorColor = _errorColor; this.errorColor = _errorColor;

View File

@ -17,9 +17,9 @@ import org.atriasoft.gale.resource.Resource;
public class ResourceConfigFile extends Resource { public class ResourceConfigFile extends Resource {
/** /**
* @brief keep the resource pointer. * keep the resource pointer.
* @note Never free this pointer by your own... * @note Never free this pointer by your own...
* @param[in] _filename Name of the configuration file. * @param _filename Name of the configuration file.
* @return pointer on the resource or null if an error occured. * @return pointer on the resource or null if an error occured.
*/ */
public static ResourceConfigFile keep(final String name) { public static ResourceConfigFile keep(final String name) {

View File

@ -52,7 +52,7 @@ public class ResourceTexture2 extends Resource {
*/ */
/** /**
* @brief get the next power 2 if the input * get the next power 2 if the input
* @param value Value that we want the next power of 2 * @param value Value that we want the next power of 2
* @return result value * @return result value
*/ */
@ -168,9 +168,9 @@ public class ResourceTexture2 extends Resource {
}; };
/** /**
* @brief Set the image in the texture system * Set the image in the texture system
* @note It will resize in square2 if needed by the system. * @note It will resize in square2 if needed by the system.
* @param[in] _image Image to set. * @param _image Image to set.
*/ */
public synchronized void set(final Image _image) { public synchronized void set(final Image _image) {
Log.debug("Set a new image in a texture:"); Log.debug("Set a new image in a texture:");
@ -187,9 +187,9 @@ public class ResourceTexture2 extends Resource {
}; };
/** /**
* @brief Set the Filter mode to apply at the image when display with a scale * Set the Filter mode to apply at the image when display with a scale
* (not 1:1 ratio) * (not 1:1 ratio)
* @param[in] _value Value of the new filter mode * @param _value Value of the new filter mode
*/ */
public void setFilterMode(final TextureFilter _filter) { public void setFilterMode(final TextureFilter _filter) {
this.filter = _filter; this.filter = _filter;
@ -202,8 +202,8 @@ public class ResourceTexture2 extends Resource {
}; };
/** /**
* @brief Set the repeate mode of the images if UV range is out of [0..1] * Set the repeate mode of the images if UV range is out of [0..1]
* @param[in] _value Value of the new repeate mode * @param _value Value of the new repeate mode
*/ */
public void setRepeat(final boolean _value) { public void setRepeat(final boolean _value) {
this.repeat = _value; this.repeat = _value;

View File

@ -19,12 +19,12 @@ public class ResourceTextureFile extends ResourceTexture2 {
public static Vector2i sizeDefault = new Vector2i(0, 0); public static Vector2i sizeDefault = new Vector2i(0, 0);
/** /**
* @brief keep the resource pointer. * keep the resource pointer.
* @note Never free this pointer by your own... * @note Never free this pointer by your own...
* @param[in] _filename Name of the image file. * @param _filename Name of the image file.
* @param[in] _requested size of the image (usefull when loading .svg to * @param _requested size of the image (usefull when loading .svg to
* automatic rescale) * automatic rescale)
* @param[in] _sizeRegister size register in named (When you preaload the images * @param _sizeRegister size register in named (When you preaload the images
* the size write here will be ) * the size write here will be )
* @return pointer on the resource or null if an error occured. * @return pointer on the resource or null if an error occured.
*/ */

View File

@ -42,8 +42,8 @@ public class ResourceTexturedFont extends ResourceTexture2 {
} }
/** /**
* @brief Get all the Path contain in the specidy path: * Get all the Path contain in the specidy path:
* @param[in] _path Generic path to parse ... * @param _path Generic path to parse ...
* @return The list of path found * @return The list of path found
* @example[start] auto out = explodeMultiplePath("DATA:///font?lib=ewol"); // * @example[start] auto out = explodeMultiplePath("DATA:///font?lib=ewol"); //
* out contain: {"DATA:///font", * out contain: {"DATA:///font",
@ -257,8 +257,8 @@ public class ResourceTexturedFont extends ResourceTexture2 {
} }
/** /**
* @brief add a glyph in a texture font. * add a glyph in a texture font.
* @param[in] _val Char value to add. * @param _val Char value to add.
* @return true if the image size have change, false otherwise * @return true if the image size have change, false otherwise
*/ */
private synchronized boolean addGlyph(final Character _val) { private synchronized boolean addGlyph(final Character _val) {
@ -334,7 +334,7 @@ public class ResourceTexturedFont extends ResourceTexture2 {
} }
/** /**
* @brief get the font height (user friendly) * get the font height (user friendly)
* @return Dimention of the font the user requested * @return Dimention of the font the user requested
*/ */
public int getFontSize() { public int getFontSize() {
@ -342,9 +342,9 @@ public class ResourceTexturedFont extends ResourceTexture2 {
} }
/** /**
* @brief get the pointer on the coresponding glyph * get the pointer on the coresponding glyph
* @param[in] _charcode The unicodeValue * @param _charcode The unicodeValue
* @param[in] _displayMode Mode to display the currrent font * @param _displayMode Mode to display the currrent font
* @return The pointer on the glyph == > never null * @return The pointer on the glyph == > never null
*/ */
public synchronized GlyphProperty getGlyph(final Character _charcode, final FontMode _displayMode) { public synchronized GlyphProperty getGlyph(final Character _charcode, final FontMode _displayMode) {
@ -368,8 +368,8 @@ public class ResourceTexturedFont extends ResourceTexture2 {
}; };
/** /**
* @brief get the display height of this font * get the display height of this font
* @param[in] _displayMode Mode to display the currrent font * @param _displayMode Mode to display the currrent font
* @return Dimention of the font need between 2 lines * @return Dimention of the font need between 2 lines
*/ */
public int getHeight() { public int getHeight() {
@ -381,9 +381,9 @@ public class ResourceTexturedFont extends ResourceTexture2 {
} }
/** /**
* @brief get the ID of a unicode charcode * get the ID of a unicode charcode
* @param[in] _charcode The unicodeValue * @param _charcode The unicodeValue
* @param[in] _displayMode Mode to display the currrent font * @param _displayMode Mode to display the currrent font
* @return The ID in the table (if it does not exist : return 0) * @return The ID in the table (if it does not exist : return 0)
*/ */
private synchronized int getIndex(final Character _charcode, final FontMode _displayMode) { private synchronized int getIndex(final Character _charcode, final FontMode _displayMode) {
@ -415,10 +415,10 @@ public class ResourceTexturedFont extends ResourceTexture2 {
}; };
/** /**
* @brief The wrapping mode is used to prevent the non existance of a specific * The wrapping mode is used to prevent the non existance of a specific
* mode. For exemple when a blod mode does not exist, this resend a * mode. For exemple when a blod mode does not exist, this resend a
* regular mode. * regular mode.
* @param[in] _source The requested mode. * @param _source The requested mode.
* @return the best mode we have in stock. * @return the best mode we have in stock.
*/ */
public FontMode getWrappingMode(final FontMode _source) { public FontMode getWrappingMode(final FontMode _source) {

View File

@ -64,7 +64,7 @@ public class GlyphProperty {
} }
/** /**
* @brief get the status of the char, if it exist or not in the FONT * get the status of the char, if it exist or not in the FONT
* @return true if the char is availlable, false otherwise * @return true if the char is availlable, false otherwise
*/ */
public boolean exist() { public boolean exist() {
@ -89,7 +89,7 @@ public class GlyphProperty {
} }
/** /**
* @brief set the element doen not exist !!! * set the element doen not exist !!!
*/ */
public void setNotExist() { public void setNotExist() {
this.exist = false; this.exist = false;

View File

@ -7,7 +7,7 @@ package org.atriasoft.ewol.resource.font;
/** /**
* @not_in_doc * @not_in_doc
* @brief Kerning properties of one specific Glyph with an other * Kerning properties of one specific Glyph with an other
* *
* Without Kerning : * Without Kerning :
* [pre] * [pre]
@ -41,7 +41,7 @@ public class Kerning {
public float value; //!< kerning real offset public float value; //!< kerning real offset
/** /**
* @brief Simple ructor that allow to allocate the List element * Simple ructor that allow to allocate the List element
*/ */
public Kerning() { public Kerning() {
this.UVal = 0; this.UVal = 0;
@ -49,9 +49,9 @@ public class Kerning {
}; };
/** /**
* @brief Normal ructor * Normal ructor
* @param[in] _charcode The Unicode value of the coresponding character that might be before * @param _charcode The Unicode value of the coresponding character that might be before
* @param[in] _value The Kerning value of the offset (nb pixel number) * @param _value The Kerning value of the offset (nb pixel number)
*/ */
public Kerning(final Character _charcode, final float _value) { public Kerning(final Character _charcode, final float _value) {
this.UVal = _charcode; this.UVal = _charcode;

View File

@ -11,9 +11,9 @@ import org.atriasoft.ewol.Ewol;
public class Message { public class Message {
/** /**
* @brief Create a simple pop-up message on the screen for application error. * Create a simple pop-up message on the screen for application error.
* @param[in] _type Type of the error. * @param _type Type of the error.
* @param[in] _message message to display (decorated text) * @param _message message to display (decorated text)
*/ */
private static void create(Type _type, String _message){ private static void create(Type _type, String _message){
StdPopUp tmpPopUp = new StdPopUp(); StdPopUp tmpPopUp = new StdPopUp();
@ -37,31 +37,31 @@ public class Message {
} }
/** /**
* @brief Create a simple information message * Create a simple information message
* @param[in] _message message to display (decorated text) * @param _message message to display (decorated text)
*/ */
public static void displayInfo(String _message){ public static void displayInfo(String _message){
create(Type.info, _message); create(Type.info, _message);
} }
/** /**
* @brief Create a simple warning message * Create a simple warning message
* @param[in] _message message to display (decorated text) * @param _message message to display (decorated text)
*/ */
public static void displayWarning(String _message) { public static void displayWarning(String _message) {
create(Type.warning, _message); create(Type.warning, _message);
} }
/** /**
* @brief Create a simple error message * Create a simple error message
* @param[in] _message message to display (decorated text) * @param _message message to display (decorated text)
*/ */
public static void displayError(String _message) { public static void displayError(String _message) {
create(Type.error,_message); create(Type.error,_message);
} }
/** /**
* @brief Create a simple critical message * Create a simple critical message
* @param[in] _message message to display (decorated text) * @param _message message to display (decorated text)
*/ */
public static void displayCritical(String _message){ public static void displayCritical(String _message){
create(Type.critical, _message); create(Type.critical, _message);

View File

@ -15,26 +15,26 @@ import org.atriasoft.exml.model.XmlNode;
*/ */
/* /*
* @ingroup ewolWidgetGroup * @ingroup ewolWidgetGroup
* @brief the Cotainer widget is a widget that have an only one subWidget * the Cotainer widget is a widget that have an only one subWidget
*/ */
class Container extends Widget { class Container extends Widget {
protected Widget subWidget = null; protected Widget subWidget = null;
/** /**
* @brief Constructor * Constructor
*/ */
public Container() { public Container() {
super(); super();
} }
/** /**
* @brief get the main node widget * get the main node widget
* @return the requested pointer on the node * @return the requested pointer on the node
*/ */
public Widget getSubWidget(){ public Widget getSubWidget(){
return this.subWidget; return this.subWidget;
} }
/** /**
* @brief set the subWidget node widget. * set the subWidget node widget.
* @param[in] _newWidget The widget to add. * @param _newWidget The widget to add.
*/ */
public void setSubWidget(Widget _newWidget){ public void setSubWidget(Widget _newWidget){
if (_newWidget == null) { if (_newWidget == null) {
@ -49,9 +49,9 @@ class Container extends Widget {
requestUpdateSize(); requestUpdateSize();
} }
/** /**
* @brief Replace a old subwidget with a new one. * Replace a old subwidget with a new one.
* @param[in] _oldWidget The widget to replace. * @param _oldWidget The widget to replace.
* @param[in] _newWidget The widget to set. * @param _newWidget The widget to set.
*/ */
public void subWidgetReplace( Widget _oldWidget, public void subWidgetReplace( Widget _oldWidget,
Widget _newWidget){ Widget _newWidget){
@ -68,7 +68,7 @@ class Container extends Widget {
requestUpdateSize(); requestUpdateSize();
} }
/** /**
* @brief remove the subWidget node (async). * remove the subWidget node (async).
*/ */
public void subWidgetRemove() { public void subWidgetRemove() {
if (this.subWidget != null) { if (this.subWidget != null) {
@ -79,7 +79,7 @@ class Container extends Widget {
} }
} }
/** /**
* @brief Unlink the subwidget Node. * Unlink the subwidget Node.
*/ */
public void subWidgetUnLink(){ public void subWidgetUnLink(){
if (this.subWidget != null) { if (this.subWidget != null) {

View File

@ -18,7 +18,7 @@ import java.util.List;
/** /**
* @ingroup ewolWidgetGroup * @ingroup ewolWidgetGroup
* @brief the Cotainer widget is a widget that have an only one subWidget * the Cotainer widget is a widget that have an only one subWidget
*/ */
public class ContainerN extends Widget { public class ContainerN extends Widget {
@XmlManaged() @XmlManaged()
@ -29,7 +29,7 @@ public class ContainerN extends Widget {
protected List<Widget> subWidget = new ArrayList<>(); protected List<Widget> subWidget = new ArrayList<>();
protected Vector2b subExpend = new Vector2b(false,false); //!< reference of the sub element expention requested. protected Vector2b subExpend = new Vector2b(false,false); //!< reference of the sub element expention requested.
/** /**
* @brief Constructor * Constructor
*/ */
protected ContainerN() {} protected ContainerN() {}
// herited function // herited function
@ -49,7 +49,7 @@ public class ContainerN extends Widget {
return res; return res;
} }
/** /**
* @brief remove all sub element from the widget. * remove all sub element from the widget.
*/ */
public void subWidgetRemoveAll(){ public void subWidgetRemoveAll(){
for(Widget it : this.subWidget) { for(Widget it : this.subWidget) {
@ -61,15 +61,15 @@ public class ContainerN extends Widget {
this.subWidget.clear(); this.subWidget.clear();
} }
/** /**
* @brief remove all sub element from the widget (delayed to prevent remove in the callbback). * remove all sub element from the widget (delayed to prevent remove in the callbback).
*/ */
public void subWidgetRemoveAllDelayed(){ public void subWidgetRemoveAllDelayed(){
subWidgetRemoveAll(); subWidgetRemoveAll();
} }
/** /**
* @brief Replace a old subwidget with a new one. * Replace a old subwidget with a new one.
* @param[in] _oldWidget The widget to replace. * @param _oldWidget The widget to replace.
* @param[in] _newWidget The widget to set. * @param _newWidget The widget to set.
*/ */
public void subWidgetReplace(Widget _oldWidget, public void subWidgetReplace(Widget _oldWidget,
Widget _newWidget) { Widget _newWidget) {
@ -94,8 +94,8 @@ public class ContainerN extends Widget {
requestUpdateSize(); requestUpdateSize();
} }
/** /**
* @brief add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) * add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
* @param[in] _newWidget the element pointer * @param _newWidget the element pointer
* @return the ID of the set element * @return the ID of the set element
*/ */
public int subWidgetAdd(Widget _newWidget) { public int subWidgetAdd(Widget _newWidget) {
@ -120,8 +120,8 @@ public class ContainerN extends Widget {
return subWidgetAdd(_newWidget); return subWidgetAdd(_newWidget);
}; };
/** /**
* @brief add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) * add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
* @param[in] _newWidget the element pointer * @param _newWidget the element pointer
* @return the ID of the set element * @return the ID of the set element
*/ */
public int subWidgetAddStart(Widget _newWidget) { public int subWidgetAddStart(Widget _newWidget) {
@ -142,8 +142,8 @@ public class ContainerN extends Widget {
return subWidgetAddStart(_newWidget); return subWidgetAddStart(_newWidget);
}; };
/** /**
* @brief remove definitly a widget from the system and this layer. * remove definitly a widget from the system and this layer.
* @param[in] _newWidget the element pointer. * @param _newWidget the element pointer.
*/ */
public void subWidgetRemove(Widget _newWidget){ public void subWidgetRemove(Widget _newWidget){
if (_newWidget == null) { if (_newWidget == null) {
@ -165,8 +165,8 @@ public class ContainerN extends Widget {
} }
} }
/** /**
* @brief Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...) * Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...)
* @param[in] _newWidget the element pointer. * @param _newWidget the element pointer.
*/ */
public void subWidgetUnLink(Widget _newWidget) { public void subWidgetUnLink(Widget _newWidget) {
if (_newWidget == null) { if (_newWidget == null) {

View File

@ -40,25 +40,25 @@ namespace ewol {
int this.colorId; //!< Color of the image. int this.colorId; //!< Color of the image.
public: public:
/** /**
* @brief *
*/ */
Image(); Image();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(Image, "Image"); DECLARE_WIDGET_FACTORY(Image, "Image");
/** /**
* @brief *
*/ */
~Image(); ~Image();
/** /**
* @brief set All the configuration of the current image * set All the configuration of the current image
* @param[in] _uri URI of the new image * @param _uri URI of the new image
* @param[in] _border New border size to set * @param _border New border size to set
*/ */
void set( etk::Uri _uri, gale::Dimension _border); void set( etk::Uri _uri, gale::Dimension _border);
/** /**
* @brief Set an image with direct elements * Set an image with direct elements
* @param[in] _image Image to set in the display * @param _image Image to set in the display
*/ */
void setCustumSource( egami::Image _image); void setCustumSource( egami::Image _image);
protected: protected:

View File

@ -22,15 +22,15 @@ class Label extends Widget {
int this.colorDefaultBgText; //!< Default Background color of the text int this.colorDefaultBgText; //!< Default Background color of the text
protected: protected:
/** /**
* @brief Constructor * Constructor
* @param[in] _newLabel The displayed decorated text. * @param _newLabel The displayed decorated text.
*/ */
Label(); Label();
void init() ; void init() ;
public: public:
DECLARE_WIDGET_FACTORY(Label, "Label"); DECLARE_WIDGET_FACTORY(Label, "Label");
/** /**
* @brief destructor * destructor
*/ */
~Label(); ~Label();
protected: protected:

View File

@ -14,8 +14,8 @@ public class Sizer extends ContainerN {
public displayMode propertyMode; //!< Methode to display the widget list (vert/hory ...) public displayMode propertyMode; //!< Methode to display the widget list (vert/hory ...)
public Dimension propertyBorderSize; //!< Border size needed for all the display public Dimension propertyBorderSize; //!< Border size needed for all the display
/** /**
* @brief Constructor * Constructor
* @param[in] _mode The mode to display the elements * @param _mode The mode to display the elements
*/ */
public Sizer(); public Sizer();
public void onChangeSize() ; public void onChangeSize() ;

View File

@ -25,7 +25,7 @@ class Spacer extends Widget {
@EwolDescription(value = "background of the spacer") @EwolDescription(value = "background of the spacer")
protected Color propertyColor; //!< Background color protected Color propertyColor; //!< Background color
/** /**
* @brief Main ructer * Main ructer
*/ */
public Spacer() { public Spacer() {

View File

@ -33,9 +33,9 @@ public class WidgetManager {
private Runnable funcRedrawNeeded = null; private Runnable funcRedrawNeeded = null;
/** /**
* @brief Create a widget with his name. * Create a widget with his name.
* @param[in] _name Name of the widget to create. * @param _name Name of the widget to create.
* @param[in] _node Reference on the XML node. * @param _node Reference on the XML node.
* @return The widget created (null if it does not exist). * @return The widget created (null if it does not exist).
*/ */
/* /*
@ -84,9 +84,9 @@ public class WidgetManager {
/** /**
* @throws Exception * @throws Exception
* @brief add a factory of a specific widget. * add a factory of a specific widget.
* @param[in] _name Name of the widget that is associated of the factory. * @param _name Name of the widget that is associated of the factory.
* @param[in] _class class interface * @param _class class interface
*/ */
public void addWidgetCreator(final String _name, final Class<?> _class) throws Exception { public void addWidgetCreator(final String _name, final Class<?> _class) throws Exception {
if (_class == null) { if (_class == null) {
@ -104,8 +104,8 @@ public class WidgetManager {
} }
/** /**
* @brief Create a widget with his name. * Create a widget with his name.
* @param[in] _name Name of the widget to create. * @param _name Name of the widget to create.
* @return The widget created (null if it does not exist). * @return The widget created (null if it does not exist).
*/ */
public Widget create(final String _name) { public Widget create(final String _name) {
@ -141,8 +141,8 @@ public class WidgetManager {
} }
/** /**
* @brief Check if an Widget exist * Check if an Widget exist
* @param[in] _name Name of the widget to check. * @param _name Name of the widget to check.
* @return true The Widget exist. * @return true The Widget exist.
* @return false The Widget Does NOT exist. * @return false The Widget Does NOT exist.
*/ */
@ -151,7 +151,7 @@ public class WidgetManager {
} }
/** /**
* @brief Get the current Focused widget. * Get the current Focused widget.
* @return The pointer on the current focused element. * @return The pointer on the current focused element.
*/ */
public Widget focusGet() { public Widget focusGet() {
@ -159,8 +159,8 @@ public class WidgetManager {
} }
/** /**
* @brief Request a focus on a specify widget. * Request a focus on a specify widget.
* @param[in] _newWidget Widget that might get the focus. * @param _newWidget Widget that might get the focus.
*/ */
public void focusKeep(final Widget _newWidget) { public void focusKeep(final Widget _newWidget) {
if (_newWidget == null) { if (_newWidget == null) {
@ -187,7 +187,7 @@ public class WidgetManager {
} }
/** /**
* @brief Release the current focus (back on default if possible). * Release the current focus (back on default if possible).
*/ */
public void focusRelease() { public void focusRelease() {
final Widget focusWidgetDefault = this.focusWidgetDefault.get(); final Widget focusWidgetDefault = this.focusWidgetDefault.get();
@ -209,8 +209,8 @@ public class WidgetManager {
} }
/** /**
* @brief Set the default focus when none selected. * Set the default focus when none selected.
* @param[in] _newWidget Widget that might get the focus (when nothing else). * @param _newWidget Widget that might get the focus (when nothing else).
*/ */
public void focusSetDefault(final Widget _newWidget) { public void focusSetDefault(final Widget _newWidget) {
if ((_newWidget != null) && (!_newWidget.propertyCanFocus)) { if ((_newWidget != null) && (!_newWidget.propertyCanFocus)) {
@ -234,7 +234,7 @@ public class WidgetManager {
} }
/** /**
* @brief Check if a redraw has been requested (set the local value back at false) * Check if a redraw has been requested (set the local value back at false)
* @return true if something to be redraw * @return true if something to be redraw
*/ */
public boolean isDrawingNeeded() { public boolean isDrawingNeeded() {
@ -244,7 +244,7 @@ public class WidgetManager {
} }
/** /**
* @brief Get the list of all Widget that can be created. * Get the list of all Widget that can be created.
* @return Separate with ',' string list. * @return Separate with ',' string list.
*/ */
public String list() { public String list() {
@ -252,7 +252,7 @@ public class WidgetManager {
} }
/** /**
* @brief Mark the display to redraw * Mark the display to redraw
*/ */
public void markDrawingIsNeeded() { public void markDrawingIsNeeded() {
if (this.haveRedraw) { if (this.haveRedraw) {
@ -265,8 +265,8 @@ public class WidgetManager {
} }
/** /**
* @brief Set a callback when we need redraw the display (need by MacOs) * Set a callback when we need redraw the display (need by MacOs)
* @param[in] _func function to call * @param _func function to call
*/ */
public void setCallbackonRedrawNeeded(final Runnable _func) { public void setCallbackonRedrawNeeded(final Runnable _func) {
this.funcRedrawNeeded = _func; this.funcRedrawNeeded = _func;

View File

@ -16,7 +16,7 @@ import org.atriasoft.ewol.resource.ResourceColorFile;
*/ */
/** /**
* @brief Windows basic interface * Windows basic interface
*/ */
public class Windows extends Widget { public class Windows extends Widget {
@ -41,12 +41,12 @@ public class Windows extends Widget {
public Widget getWidgetAtPos(Vector2f _pos); public Widget getWidgetAtPos(Vector2f _pos);
/** /**
* @brief Called when property change: Color configuration file * Called when property change: Color configuration file
*/ */
protected void onChangePropertyColor(); protected void onChangePropertyColor();
/** /**
* @brief Called when property change: Title * Called when property change: Title
*/ */
protected void onChangePropertyTitle(); protected void onChangePropertyTitle();
@ -57,7 +57,7 @@ public class Windows extends Widget {
public void onRegenerateDisplay(); public void onRegenerateDisplay();
/** /**
* @brief Get the number of pop-up * Get the number of pop-up
* @return Count of pop-up * @return Count of pop-up
*/ */
public int popUpCount() { public int popUpCount() {
@ -65,21 +65,21 @@ public class Windows extends Widget {
} }
/** /**
* @brief Remove the pop-up on top. * Remove the pop-up on top.
*/ */
public void popUpWidgetPop(); public void popUpWidgetPop();
/** /**
* @brief Add a pop-up on the Windows. * Add a pop-up on the Windows.
* @param[in] _widget Widget to set on top of the pop-up. * @param _widget Widget to set on top of the pop-up.
*/ */
public void popUpWidgetPush(Widget _widget); public void popUpWidgetPush(Widget _widget);
public void requestDestroyFromChild(EwolObject _child); //!< main sub-widget of the Windows. public void requestDestroyFromChild(EwolObject _child); //!< main sub-widget of the Windows.
/** /**
* @brief Set the main widget of the application. * Set the main widget of the application.
* @param[in] _widget Widget to set in the windows. * @param _widget Widget to set in the windows.
*/ */
public void setSubWidget(Widget _widget); public void setSubWidget(Widget _widget);