libwiigui documentation updates

This commit is contained in:
dborth 2009-10-17 00:15:58 +00:00
parent 16e4b64b1c
commit 914bb130c9
4 changed files with 12 additions and 53 deletions

View File

@ -139,7 +139,7 @@ class GuiSound
//!\param s Pointer to the sound data
//!\param l Length of sound data
//!\param t Sound format type (SOUND_PCM or SOUND_OGG)
GuiSound(const u8 * s, int l, int t);
GuiSound(const u8 * s, s32 l, int t);
//!Destructor
~GuiSound();
//!Start sound playback
@ -306,8 +306,8 @@ class GuiElement
//!\param c Clickable
void SetClickable(bool c);
//!Sets whether or not the element is holdable
//!\param c Holdable
void SetHoldable(bool d);
//!\param h Holdable
void SetHoldable(bool h);
//!Gets the element's current state
//!\return state
int GetState();
@ -606,7 +606,7 @@ class GuiText : public GuiElement
//!\param c Font color
GuiText(const char * t, int s, GXColor c);
//!\overload
//!\Assumes SetPresets() has been called to setup preferred text attributes
//!Assumes SetPresets() has been called to setup preferred text attributes
//!\param t Text
GuiText(const char * t);
//!Destructor
@ -628,7 +628,7 @@ class GuiText : public GuiElement
void SetFontSize(int s);
//!Sets the maximum width of the drawn texture image
//!\param w Maximum width
void SetMaxWidth(int width);
void SetMaxWidth(int w);
//!Enables/disables text scrolling
//!\param s Scrolling on/off
void SetScroll(int s);

View File

@ -69,11 +69,7 @@ GuiElement * GuiElement::GetParent()
{
return parentElement;
}
/**
* Get the left position of the GuiElement.
* @see SetLeft()
* @return Left position in pixel.
*/
int GuiElement::GetLeft()
{
int x = 0;
@ -104,11 +100,6 @@ int GuiElement::GetLeft()
return x + xoffset;
}
/**
* Get the top position of the GuiElement.
* @see SetTop()
* @return Top position in pixel.
*/
int GuiElement::GetTop()
{
int y = 0;
@ -179,33 +170,16 @@ int GuiElement::GetMaxY()
return ymax;
}
/**
* Get the width of the GuiElement.
* @see SetWidth()
* @return Width of the GuiElement.
*/
int GuiElement::GetWidth()
{
return width;
}
/**
* Get the height of the GuiElement.
* @see SetHeight()
* @return Height of the GuiElement.
*/
int GuiElement::GetHeight()
{
return height;
}
/**
* Set the width and height of the GuiElement.
* @param[in] Width Width in pixel.
* @param[in] Height Height in pixel.
* @see SetWidth()
* @see SetHeight()
*/
void GuiElement::SetSize(int w, int h)
{
@ -213,21 +187,11 @@ void GuiElement::SetSize(int w, int h)
height = h;
}
/**
* Get visible.
* @see SetVisible()
* @return true if visible, false otherwise.
*/
bool GuiElement::IsVisible()
{
return visible;
}
/**
* Set visible.
* @param[in] Visible Set to true to show GuiElement.
* @see IsVisible()
*/
void GuiElement::SetVisible(bool v)
{
visible = v;
@ -556,11 +520,6 @@ void GuiElement::Draw()
{
}
/**
* Check if a position is inside the GuiElement.
* @param[in] x X position in pixel.
* @param[in] y Y position in pixel.
*/
bool GuiElement::IsInside(int x, int y)
{
if(x > this->GetLeft() && x < (this->GetLeft()+width)

View File

@ -13,16 +13,16 @@
/**
* Constructor for the GuiImageData class.
*/
GuiImageData::GuiImageData(const u8 * img)
GuiImageData::GuiImageData(const u8 * i)
{
data = NULL;
width = 0;
height = 0;
if(img)
if(i)
{
PNGUPROP imgProp;
IMGCTX ctx = PNGU_SelectImageFromBuffer(img);
IMGCTX ctx = PNGU_SelectImageFromBuffer(i);
if(!ctx)
return;

View File

@ -13,10 +13,10 @@
/**
* Constructor for the GuiSound class.
*/
GuiSound::GuiSound(const u8 * snd, s32 len, int t)
GuiSound::GuiSound(const u8 * s, s32 l, int t)
{
sound = snd;
length = len;
sound = s;
length = l;
type = t;
voice = -1;
volume = 100;