Main Page   Modules   Class Hierarchy   Data Structures   File List   Data Fields   Globals  

Object appereance

Functions in this group allow to change the look of a generic GUI object. More...

Functions

void MObjectSetColor (MOBJECT obj, MTColor bgc, MTColor fgc)
 Sets the desired object foreground and background colors.

MTColor MObjectBackgroundColor (MOBJECT obj)
 Returns the desired object background color.

MTColor MObjectForegroundColor (MOBJECT obj)
 Returns the object's foreground color.

void MObjectSetBackgroundRGB (MOBJECT obj, int r, int g, int b)
void MObjectSetForegroundRGB (MOBJECT obj, int r, int g, int b)
void MObjectSetBackgroundColor (MOBJECT obj, MTColor bgc)
 Sets the desired object background colors.

void MObjectSetForegroundColor (MOBJECT obj, MTColor fgc)
 Sets the desired object foreground color.

void MObjectSetBGColorFromParent (MOBJECT obj, int true_false, int percentage)
 Enables/disables getting the object background color from the parent object.

void MObjectSetFGColorFromParent (MOBJECT obj, int true_false)
 Enables/disables getting the object foreground color from the parent object.

MTFont MObjectGetFont (MOBJECT obj)
void MObjectSetFont (MOBJECT obj, MTFont font, int resize)
void MObjectGetShadow (MOBJECT obj, int *type, int *in, int *out)
void MObjectSetShadow (MOBJECT obj, int type, int in, int out)
void MObjectSetTransparency (MOBJECT obj, CARD8 level)
CARD8 MObjectGetTransparency (MOBJECT obj)
void MObjectSetSolid (MOBJECT obj)
void MObjectSetTransparent (MOBJECT obj)
void MObjectSetBackgroundImage (MOBJECT obj, MIMAGE img, int mode)
void MObjectSetBackgroundImageFile (MOBJECT obj, const char *fname, int mode)
MIMAGE MObjectGetBackgroundImage (MOBJECT obj)
void MObjectSetColorFromBackgroundImage (MOBJECT obj)
void MObjectSetBGImageMaskByCMapIndex (MOBJECT obj, int id)
void MObjectSetBGImageMaskByPixel (MOBJECT obj, int x, int y)
void MObjectSetBGImageMaskByRGB (MOBJECT obj, int r, int g, int b)
int MObjectUsesFGColorFromParent (MOBJECT obj)
int MObjectUsesBGColorFromParent (MOBJECT obj, int *percentage_ret)

Detailed Description

Functions in this group allow to change the look of a generic GUI object.


Function Documentation

MTColor MObjectBackgroundColor MOBJECT    obj
 

Returns the desired object background color.

The returned value can be different from the actual color the object uses to display itself in case it's partially transparent.

See also:
MObjectSetBackgroundColor(), MObjectSetTransparency().

MTColor MObjectForegroundColor MOBJECT    obj
 

Returns the object's foreground color.

MIMAGE MObjectGetBackgroundImage MOBJECT    obj
 

MTFont MObjectGetFont MOBJECT    obj
 

void MObjectGetShadow MOBJECT    obj,
int *    type,
int *    in,
int *    out
 

CARD8 MObjectGetTransparency MOBJECT    obj
 

void MObjectSetBackgroundColor MOBJECT    obj,
MTColor    bgc
 

Sets the desired object background colors.

The actual background used to display the object depends on the object transparency level and the color or image background in the parent object.
More precisely, if the object is partially transparent (transparency level > 0 and < 255) then the actual object appereance will result by the combination of the parent background (either solid color or image) and the object background color.

Parameters:
obj The object which to apply the new colors to.
bgc The desired background color. If you pass in the value NOCOLOR then this function will behave exactly as MObjectSetForegroundColor().
See also:
MObjectSetColor(), MObjectSetBGColorFromParent(), MObjectSetFGColorFromParent(), MObjectSetColorFromBackgroundImage(), MObjectSetTransparency()

void MObjectSetBackgroundImage MOBJECT    obj,
MIMAGE    img,
int    mode
 

void MObjectSetBackgroundImageFile MOBJECT    obj,
const char *    fname,
int    mode
 

void MObjectSetBackgroundRGB MOBJECT    obj,
int    r,
int    g,
int    b
 

void MObjectSetBGColorFromParent MOBJECT    obj,
int    true_false,
int    percentage
 

Enables/disables getting the object background color from the parent object.

This function links the object background color to its parent color.
Object color is automatically changed as the parent changes its color. The color change propagated from the parent is recursively propagated to all children objects having the color-from-parent feature set.
The inherited color can be shifted in brightness using last argument.

Parameters:
obj The object which to apply the setting to.
true_false Boolean value stating whether the feature should be enabled or disabled.
percentage This value specifies the brightness percentace to apply when getting the color from parent. A value of 100 means get it as is.
See also:
MObjectSetFGColorFromParent(), MObjectSetColorFromBackgroundImage()

void MObjectSetBGImageMaskByCMapIndex MOBJECT    obj,
int    id
 

void MObjectSetBGImageMaskByPixel MOBJECT    obj,
int    x,
int    y
 

void MObjectSetBGImageMaskByRGB MOBJECT    obj,
int    r,
int    g,
int    b
 

void MObjectSetColor MOBJECT    obj,
MTColor    bgc,
MTColor    fgc
 

Sets the desired object foreground and background colors.

The actual background used to display the object depends on the object transparency level and the color or image background in the parent object.
More precisely, if the object is partially transparent (transparency level > 0 and < 255) then the actual object appereance will result by the combination of the parent background (either solid color or image) and the object background color.

Parameters:
obj The object which to apply the new colors to.
bgc The desired background color. If you pass in the value NOCOLOR then this function will behave exactly as MObjectSetForegroundColor().
fgc The desired foreground color. If you pass in the value NOCOLOR then this function will behave exactly as MObjectSetBackgroundColor().
See also:
MObjectSetBGColorFromParent(), MObjectSetFGColorFromParent(), MObjectSetColorFromBackgroundImage(), MObjectSetTransparency()

void MObjectSetColorFromBackgroundImage MOBJECT    obj
 

void MObjectSetFGColorFromParent MOBJECT    obj,
int    true_false
 

Enables/disables getting the object foreground color from the parent object.

This function links the object foreground color to its parent color.
Object color is automatically changed as the parent changes its color. The color change propagated from the parent is recursively propagated to all children objects having the color-from-parent feature set.

Parameters:
obj The object which to apply the setting to.
true_false Boolean value stating whether the feature should be enabled or disabled.
See also:
MObjectSetBGColorFromParent(), MObjectSetColorFromBackgroundImage()

void MObjectSetFont MOBJECT    obj,
MTFont    font,
int    resize
 

void MObjectSetForegroundColor MOBJECT    obj,
MTColor    fgc
 

Sets the desired object foreground color.

Parameters:
obj The object which to apply the new colors to.
fgc The desired foreground color.
See also:
MObjectSetColor(), MObjectSetBGColorFromParent(), MObjectSetFGColorFromParent(), MObjectSetColorFromBackgroundImage(), MObjectSetTransparency()

void MObjectSetForegroundRGB MOBJECT    obj,
int    r,
int    g,
int    b
 

void MObjectSetShadow MOBJECT    obj,
int    type,
int    in,
int    out
 

void MObjectSetSolid MOBJECT    obj
 

void MObjectSetTransparency MOBJECT    obj,
CARD8    level
 

void MObjectSetTransparent MOBJECT    obj
 

int MObjectUsesBGColorFromParent MOBJECT    obj,
int *    percentage_ret
 

int MObjectUsesFGColorFromParent MOBJECT    obj
 


Generated on Sun Jun 29 13:03:09 2003 for MGui API by doxygen1.3-rc2