back

Background in custom objects

This page gives you information on how uiZ internally draws uiz_back from the perspective of creating your own uiZ objects.

Functions

These functions are available:

• uiz_back([backmode]): Draws the background given by the background variables over the entire object. Needs to be drawn within uiz_cntn()..

  • backmode: This is an optional argument, forcing the state that would be normally controller by the state of the mouse. If omitted, it will be either uiz_nomouse (0), uiz_mouseover (1) or uiz_mouseclick (2). This argument controls whether to draw the normal, over, in or out variant of your background.

• uiz_back_at(rx, ry, rlx, rly, [backmode]): Draws the background given by the background variables over a custom area. Needs to be drawn within uiz_cntn()..

  • rx: The left side coordinate of your background.
  • ry: The top side coordinate of your background.
  • rlx: The right side coordinate of your background.
  • rly: The bottom side coordinate of your background.
  • backmode: This is an optional argument, forcing the state that would be normally controller by the state of the mouse. If omitted, it will be either uiz_nomouse (0), uiz_mouseover (1) or uiz_mouseclick (2). This argument controls whether to draw the normal, over, in or out variant of your background.

• uiz_back_margin(margins, [backmode]): Draws the background given by the background variables over the entire object, plus a given margin. The space is created by making the background bigger. Supply negative numbers to make the back smaller. Needs to be drawn within uiz_cntn()..

  • margins: How much smaller the background has be to at every side.
  • backmode: This is an optional argument, forcing the state that would be normally controller by the state of the mouse. If omitted, it will be either uiz_nomouse (0), uiz_mouseover (1) or uiz_mouseclick (2). This argument controls whether to draw the normal, over, in or out variant of your background.

Multiple backgrounds

Some objects (and perhaps yours) have multiple backgrounds. The window for example has both a top bar and a main background. To make this work you can use the uiz_back_ functions with a _topbar or _item postfix. You also need to copy over the correct variables from the window, function bar, mouse menu or switch. When drawing a background with a postfix, you are required to first "capture" the settings of the normal background, and then restore them again later on. Use these functions to do so:

• uiz_back_captureSettings(): Gets the current background settings as determined while fixing the current object. This is needed when drawing multiple sub backgrounds in a single objects. (most often using prefixes like item or topbar). Use uiz_back_resumeSettings() to put the captures settings back after you have used your item or topbar functions. The captured settings are stored in local object variables.
• uiz_back_resumeSettings(): Sets the current background settings as determined using uiz_back_captureSettings(). This is needed when drawing multiple sub backgrounds in a single objects. (most often using prefixes like item or topbar). Use uiz_back_captureSettings() to get the captured settings.