Modules | Functions

## Driver Interface

Collaboration diagram for Driver Interface:

### Modules

| Driver Font Interface
| Driver Information Interface

### Functions

IUP_SDK_API int | iupdrvSetGlobal (const char *name, const char *value)
IUP_SDK_API char * | iupdrvGetGlobal (const char *name)
IUP_SDK_API void | iupdrvSetIdleFunction (Icallback func)
IUP_SDK_API void | iupdrvScreenToClient (Ihandle *ih, int *x, int *y)
IUP_SDK_API void | iupdrvClientToScreen (Ihandle *ih, int *x, int *y)
IUP_SDK_API int | iupdrvIsVisible (Ihandle *ih)
IUP_SDK_API int | iupdrvIsActive (Ihandle *ih)
IUP_SDK_API void | iupdrvSetFocus (Ihandle *ih)
IUP_SDK_API void | iupdrvSetVisible (Ihandle *ih, int enable)
IUP_SDK_API void | iupdrvSetActive (Ihandle *ih, int enable)
IUP_SDK_API void | iupdrvPostRedraw (Ihandle *ih)
IUP_SDK_API void | iupdrvRedrawNow (Ihandle *ih)
IUP_SDK_API void | iupdrvReparent (Ihandle *ih)
IUP_SDK_API int | iupdrvGetScrollbarSize (void)
IUP_SDK_API void | iupdrvActivate (Ihandle *ih)
IUP_SDK_API int | iupdrvMenuGetMenuBarSize (Ihandle *ih)
IUP_SDK_API void | iupdrvSendKey (int key, int press)
IUP_SDK_API void | iupdrvSendMouse (int x, int y, int bt, int status)
IUP_SDK_API void | iupdrvWarpPointer (int x, int y)
IUP_SDK_API void | iupdrvKeyEncode (int key, unsigned int *keyval, unsigned int *state)
IUP_SDK_API void | iupdrvSleep (int time)
IUP_SDK_API void | iupdrvSetAccessibleTitle (Ihandle *ih, const char *title)

### Detailed Description

  Each driver must export the symbols defined here.

  See iup_drv.h

### Function Documentation

IUP_SDK_API int iupdrvSetGlobal | ( | const char * | name,
|  | const char * | value |
| ) |  |  |

Sets a global environment attribute. Called from IupSetGlobal and IupStoreGlobal. Must return 1 is process the attribute, or 0 is not.

IUP_SDK_API char* iupdrvGetGlobal | ( | const char * | name | ) |

Returns a global environment attribute. Called from IupGetGlobal.

IUP_SDK_API void iupdrvSetIdleFunction | ( | Icallback | func | ) |

Changes the idle callback. Called from IupSetFunction.

IUP_SDK_API void iupdrvScreenToClient | ( | Ihandle * | ih,
|  | int * | x,
|  | int * | y |
| ) |  |  |

Convert the coordinates from screen relative to client area.

IUP_SDK_API void iupdrvClientToScreen | ( | Ihandle * | ih,
|  | int * | x,
|  | int * | y |
| ) |  |  |

Convert the coordinates from relative client area to screen.

IUP_SDK_API int iupdrvIsVisible | ( | Ihandle * | ih | ) |

Returns true if the element is visible.

IUP_SDK_API int iupdrvIsActive | ( | Ihandle * | ih | ) |

Returns true if the element is active.

IUP_SDK_API void iupdrvSetFocus | ( | Ihandle * | ih | ) |

Actually changes the focus to the given element.

IUP_SDK_API void iupdrvSetVisible | ( | Ihandle * | ih,
|  | int | enable |
| ) |  |  |

Changes the visible state of an element. Not used for dialogs.

IUP_SDK_API void iupdrvSetActive | ( | Ihandle * | ih,
|  | int | enable |
| ) |  |  |

Changes the active state of an element.

IUP_SDK_API void iupdrvPostRedraw | ( | Ihandle * | ih | ) |

Post a redraw of a control and children.

IUP_SDK_API void iupdrvRedrawNow | ( | Ihandle * | ih | ) |

Force a redraw of a control and children.

IUP_SDK_API void iupdrvReparent | ( | Ihandle * | ih | ) |

Reparent the native control.

IUP_SDK_API int iupdrvGetScrollbarSize | ( | void |  | ) |

Size of the scrollbar.

IUP_SDK_API void iupdrvActivate | ( | Ihandle * | ih | ) |

Activates a button or toggle.

IUP_SDK_API int iupdrvMenuGetMenuBarSize | ( | Ihandle * | ih | ) |

Returns the height of a menu bar.

IUP_SDK_API void iupdrvSendKey | ( | int | key,
|  | int | press |
| ) |  |  |

Sends a global keyboard message.

IUP_SDK_API void iupdrvSendMouse | ( | int | x,
|  | int | y,
|  | int | bt,
|  | int | status |
| ) |  |  |

Sends a global mouse message. status: 2=double pressed, 1=pressed, 0=released, -1=move

IUP_SDK_API void iupdrvWarpPointer | ( | int | x,
|  | int | y |
| ) |  |  |

Moves the cursor on screen.

IUP_SDK_API void iupdrvKeyEncode | ( | int | key,
|  | unsigned int * | keyval,
|  | unsigned int * | state |
| ) |  |  |

Translates an IUP key definition into a system definition.

IUP_SDK_API void iupdrvSleep | ( | int | time | ) |

Suspends execution for the specified number of milliseconds.

IUP_SDK_API void iupdrvSetAccessibleTitle | ( | Ihandle * | ih,
|  | const char * | title |
| ) |  |  |

Sets the accessibility text for screen readers.