Commit f8663297 authored by Olivier Teulière's avatar Olivier Teulière

* skins2/*: fixed some doxygen comments

parent b9864a81
...@@ -66,8 +66,10 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool> ...@@ -66,8 +66,10 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool>
virtual UString getTooltipText() const virtual UString getTooltipText() const
{ return UString( getIntf(), "" ); } { return UString( getIntf(), "" ); }
/// Overload this method if you want to do something special when /**
/// the layout is resized * Overload this method if you want to do something special when
* the layout is resized
*/
virtual void onResize() {} virtual void onResize() {}
/// Get the help text /// Get the help text
...@@ -87,14 +89,18 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool> ...@@ -87,14 +89,18 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool>
CtrlGeneric( intf_thread_t *pIntf, const UString &rHelp, CtrlGeneric( intf_thread_t *pIntf, const UString &rHelp,
VarBool *pVisible = NULL ); VarBool *pVisible = NULL );
/// Tell the layout when the image has changed, with the size of the /**
/// rectangle to repaint and its offset. * Tell the layout when the image has changed, with the size of the
/// Use the default values to repaint the whole window * rectangle to repaint and its offset.
* Use the default values to repaint the whole window
*/
virtual void notifyLayout( int witdh = -1, int height = -1, virtual void notifyLayout( int witdh = -1, int height = -1,
int xOffSet = 0, int yOffSet = 0 ) const; int xOffSet = 0, int yOffSet = 0 ) const;
/// Same as notifyLayout(), but takes optional images as parameters. /**
/// The maximum size(s) of the images will be used for repainting. * Same as notifyLayout(), but takes optional images as parameters.
* The maximum size(s) of the images will be used for repainting.
*/
void notifyLayoutMaxSize( const Box *pImg1 = NULL, void notifyLayoutMaxSize( const Box *pImg1 = NULL,
const Box *pImg2 = NULL ); const Box *pImg2 = NULL );
...@@ -110,8 +116,10 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool> ...@@ -110,8 +116,10 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool>
/// Get the associated window, if any /// Get the associated window, if any
virtual TopWindow *getWindow() const; virtual TopWindow *getWindow() const;
/// Overload this method if you want to do something special when /**
/// the Position object is set * Overload this method if you want to do something special when
* the Position object is set
*/
virtual void onPositionChange() {} virtual void onPositionChange() {}
/// Overload this method to get notified of bool variable changes /// Overload this method to get notified of bool variable changes
......
...@@ -100,8 +100,10 @@ class GenericLayout: public SkinObject, public Box ...@@ -100,8 +100,10 @@ class GenericLayout: public SkinObject, public Box
/// Resize the layout /// Resize the layout
virtual void resize( int width, int height ); virtual void resize( int width, int height );
/// Add a control in the layout at the given position, and /**
/// the optional given layer * Add a control in the layout at the given position, and
* the optional given layer
*/
virtual void addControl( CtrlGeneric *pControl, virtual void addControl( CtrlGeneric *pControl,
const Position &rPosition, const Position &rPosition,
int layer ); int layer );
...@@ -110,9 +112,11 @@ class GenericLayout: public SkinObject, public Box ...@@ -110,9 +112,11 @@ class GenericLayout: public SkinObject, public Box
virtual const list<LayeredControl> &getControlList() const; virtual const list<LayeredControl> &getControlList() const;
/// Called by a control when its image has changed /// Called by a control when its image has changed
/// The arguments indicate the size of the rectangle to refresh, /**
/// and the offset (from the control position) of this rectangle. * The arguments indicate the size of the rectangle to refresh,
/// Use a negative width or height to refresh the layout completely * and the offset (from the control position) of this rectangle.
* Use a negative width or height to refresh the layout completely
*/
virtual void onControlUpdate( const CtrlGeneric &rCtrl, virtual void onControlUpdate( const CtrlGeneric &rCtrl,
int width, int height, int width, int height,
int xOffSet, int yOffSet ); int xOffSet, int yOffSet );
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment