Difference between revisions of "Windows"

From uGFX Wiki
Jump to: navigation, search
(Window creation)
(Window creation)
Line 24: Line 24:
 
</syntaxhighlight>
 
</syntaxhighlight>
 
Examples on how to use this struct correctly can be found on each window documentation page.
 
Examples on how to use this struct correctly can be found on each window documentation page.
 +
 +
<code>gwinDestroy()</code> can be used to destroy a window that is no longer needed.
  
 
== Implemented Windows ==
 
== Implemented Windows ==

Revision as of 17:31, 1 July 2014

A window is the most basic GWIN element. All the other elements (widget, container) are based on this one. A window consists the following attributes:

  • Position
  • Size
  • Foreground color
  • Background color
  • Font

Therefore, a window is a completely passive element. It does not accept any kind of input. A list with description of the common window API can be found here.

Window creation

Each window provides a creation call with is named gwinCreateXxx() where Xxx is the name of the window. The first parameter is either a pointer to a static window object or NULL. If NULL, the object will be allocated dynamically from the heap. The second parameter is a pointer to a GWindowInit struct. This struct contains all the attributes which are needed to create the window (position, size, ...):

typedef struct GWindowInit {
   coord_t			x, y;				// The initial position relative to its parent
   coord_t			width, height;			// The initial dimension
   bool_t			show;				// Should the window be visible initially
   #if GWIN_NEED_CONTAINERS
      GHandle		        parent;				// The parent - must be a container or NULL
   #endif
} GWindowInit;

Examples on how to use this struct correctly can be found on each window documentation page.

gwinDestroy() can be used to destroy a window that is no longer needed.

Implemented Windows

These are the currently implemented windows: