dwindows: android/dw.cpp comparison

comparison android/dw.cpp @ 2710:98cc4476b376

Android: Add comments, TODOs for functions that should eventually be implmented. And descriptions of ones that probably don't need to be on Android.

author	bsmith@81767d24-ef19-dc11-ae90-00e081727c95
date	Mon, 22 Nov 2021 03:02:13 +0000
parents	3cb5aa73dace
children	26bb1e4a97d0

comparison

equal deleted inserted replaced

-:3cb5aa73dace
+:98cc4476b376
 * Parameters:
 *          handle: Handle to the MLE to freeze.
 */
 void API dw_mle_freeze(HWND handle)
 {
+/* Don't think this is necessary on Android */
 }
 /*
 * Resumes redrawing of an MLE box.
 * Parameters:
 *          handle: Handle to the MLE to thaw.
 */
 void API dw_mle_thaw(HWND handle)
 {
+/* Don't think this is necessary on Android */
 }
 HWND _dw_text_new(const char *text, ULONG cid, int status)
 {
 JNIEnv *env;
 * Returns:
 *       The selected color or the current color if cancelled.
 */
 unsigned long API dw_color_choose(unsigned long value)
 {
+/* TODO: Implement this */
 return value;
 }
 /* Draw a point on a window (preferably a render window).
 * Parameters:
 * Returns:
 *       A handle to a tree window or nullptr on failure.
 */
 HWND API dw_tree_new(ULONG cid)
 {
+/* TODO: Implement the tree if possible. */
 return nullptr;
 }
 /*
 * Inserts an item into a tree window (widget) after another item.
 * Returns:
 *       A handle to a tree item or nullptr on failure.
 */
 HTREEITEM API dw_tree_insert_after(HWND handle, HTREEITEM item, const char *title, HICN icon, HTREEITEM parent, void *itemdata)
 {
+/* TODO: Implement the tree if possible. */
 return nullptr;
 }
 /*
 * Inserts an item into a tree window (widget).
 * Returns:
 *       A handle to a tree item or nullptr on failure.
 */
 HTREEITEM API dw_tree_insert(HWND handle, const char *title, HICN icon, HTREEITEM parent, void *itemdata)
 {
+/* TODO: Implement the tree if possible. */
 return nullptr;
 }
 /*
 * Gets the text an item in a tree window (widget).
 * Returns:
 *       A malloc()ed buffer of item text to be dw_free()ed or nullptr on error.
 */
 char * API dw_tree_get_title(HWND handle, HTREEITEM item)
 {
+/* TODO: Implement the tree if possible. */
 return nullptr;
 }
 /*
 * Gets the text an item in a tree window (widget).
 * Returns:
 *       A handle to a tree item or nullptr on failure.
 */
 HTREEITEM API dw_tree_get_parent(HWND handle, HTREEITEM item)
 {
+/* TODO: Implement the tree if possible. */
 return nullptr;
 }
 /*
 * Sets the text and icon of an item in a tree window (widget).
 *          title: The text title of the entry.
 *          icon: Handle to coresponding icon.
 */
 void API dw_tree_item_change(HWND handle, HTREEITEM item, const char *title, HICN icon)
 {
+/* TODO: Implement the tree if possible. */
 }
 /*
 * Sets the item data of a tree item.
 * Parameters:
 *          item: Handle of the item to be modified.
 *          itemdata: User defined data to be associated with item.
 */
 void API dw_tree_item_set_data(HWND handle, HTREEITEM item, void *itemdata)
 {
+/* TODO: Implement the tree if possible. */
 }
 /*
 * Gets the item data of a tree item.
 * Parameters:
 * Returns:
 *       A pointer to tree item data or nullptr on failure.
 */
 void * API dw_tree_item_get_data(HWND handle, HTREEITEM item)
 {
+/* TODO: Implement the tree if possible. */
 return nullptr;
 }
 /*
 * Sets this item as the active selection.
 *       handle: Handle to the tree window (widget) to be selected.
 *       item: Handle to the item to be selected.
 */
 void API dw_tree_item_select(HWND handle, HTREEITEM item)
 {
+/* TODO: Implement the tree if possible. */
 }
 /*
 * Removes all nodes from a tree.
 * Parameters:
 *       handle: Handle to the window (widget) to be cleared.
 */
 void API dw_tree_clear(HWND handle)
 {
+/* TODO: Implement the tree if possible. */
 }
 /*
 * Expands a node on a tree.
 * Parameters:
 *       handle: Handle to the tree window (widget).
 *       item: Handle to node to be expanded.
 */
 void API dw_tree_item_expand(HWND handle, HTREEITEM item)
 {
+/* TODO: Implement the tree if possible. */
 }
 /*
 * Collapses a node on a tree.
 * Parameters:
 *       handle: Handle to the tree window (widget).
 *       item: Handle to node to be collapsed.
 */
 void API dw_tree_item_collapse(HWND handle, HTREEITEM item)
 {
+/* TODO: Implement the tree if possible. */
 }
 /*
 * Removes a node from a tree.
 * Parameters:
 * Parameters:
 *       handle: Handle to the window (widget) to be optimized.
 */
 void API dw_container_optimize(HWND handle)
 {
+/* Not necessary with no columns */
 }
 /*
 * Inserts an icon into the taskbar.
 * Parameters:
 * Note: This is only necessary on platforms that
 *       don't handle transparency automatically
 */
 void API dw_pixmap_set_transparent_color( HPIXMAP pixmap, ULONG color )
 {
+/* Not necessary on Android, all versions support transparency. */
 }
 /*
 * Creates a pixmap from internal resource graphic specified by id.
 * Parameters:
 *       x: Pointer to variable to store X coordinate or nullptr.
 *       y: Pointer to variable to store Y coordinate or nullptr.
 */
 void API dw_pointer_query_pos(long *x, long *y)
 {
+/* No mouse pointer on Android */
+if(x)
+*x = 0;
+if(y)
+*y = 0;
 }
 /*
 * Sets the X and Y coordinates of the mouse pointer.
 * Parameters:
 *       x: X coordinate.
 *       y: Y coordinate.
 */
 void API dw_pointer_set_pos(long x, long y)
 {
+/* No mouse pointer on Android */
 }
 /*
 * Create a menu object to be popped up.
 * Parameters:
 *       handle: Handle to widget for which to change.
 *       cursortype: ID of the pointer you want.
 */
 void API dw_window_set_pointer(HWND handle, int pointertype)
 {
+/* No mouse pointer on Android */
 }
 int _dw_window_hide_show(HWND handle, int state)
 {
 JNIEnv *env;
 * Returns:
 *       DW_ERROR_NONE (0) on success.
 */
 int API dw_window_set_border(HWND handle, int border)
 {
+/* No overlapping windows on Android, so no border */
 return DW_ERROR_GENERAL;
 }
 /*
 * Sets the style of a given window (widget).
 *         window: Window (widget) to look for the ENTER press.
 *         next: Window (widget) to move to next (or click)
 */
 void API dw_window_click_default(HWND handle, HWND next)
 {
+/* TODO: See if this is possible on Android */
 }
 /*
 * Captures the mouse input to this window even if it is outside the bounds.
 * Parameters:
 *       handle: Handle to receive mouse input.
 */
 void API dw_window_capture(HWND handle)
 {
+/* No mouse pointer on Android */
 }
 /*
 * Releases previous mouse capture.
 */
 void API dw_window_release(void)
 {
+/* No mouse pointer on Android */
 }
 /*
 * Changes a window's parent to newparent.
 * Parameters:
 *           handle: The window handle to destroy.
 *           newparent: The window's new parent window.
 */
 void API dw_window_reparent(HWND handle, HWND newparent)
 {
+/* TODO: Do we need to do implement this? */
 }
 /*
 * Sets the font used by a specified window (widget) handle.
 * Parameters:
 * Parameters:
 *           fontname: Font name in Dynamic Windows format.
 */
 void API dw_font_set_default(const char *fontname)
 {
+/* TODO: Implement this */
 }
 /*
 * Destroys a window and all of it's children.
 * Parameters:
 *       handle: Handle to the window (widget).
 *       bubbletext: The text in the floating bubble tooltip.
 */
 void API dw_window_set_tooltip(HWND handle, const char *bubbletext)
 {
+/* No mouse pointer on Android */
 }
 void _dw_window_set_enabled(HWND handle, jboolean state)
 {
 JNIEnv *env;
 *       handle: Handle to the window.
 *       icon: Handle to icon to be used.
 */
 void API dw_window_set_icon(HWND handle, HICN icon)
 {
+/* TODO: See if this is possible, the icon is controlled by app resources */
 }
 /*
 * Gets the child window handle with specified ID.
 * Parameters:
 * Returns:
 *       DW_ERROR_NONE (0) on success.
 */
 int API dw_window_minimize(HWND handle)
 {
+/* TODO: Not sure if we should do anything here */
 return DW_ERROR_GENERAL;
 }
 /* Causes entire window to be invalidated and redrawn.
 * Parameters:
 *           handle: Toplevel window handle to be redrawn.
 */
 void API dw_window_redraw(HWND handle)
 {
+/* Shouldn't be necessary on Android */
 }
 /*
 * Makes the window topmost.
 * Parameters:
 * Returns:
 *       DW_ERROR_NONE (0) on success.
 */
 int API dw_window_raise(HWND handle)
 {
+/* TODO: Not sure if we should do anything here */
 return DW_ERROR_GENERAL;
 }
 /*
 * Makes the window bottommost.
 * Returns:
 *       DW_ERROR_NONE (0) on success.
 */
 int API dw_window_lower(HWND handle)
 {
+/* TODO: Not sure if we should do anyting here */
 return DW_ERROR_GENERAL;
 }
 /*
 * Sets the size of a given window (widget).
 *          width: New width in pixels.
 *          height: New height in pixels.
 */
 void API dw_window_set_size(HWND handle, ULONG width, ULONG height)
 {
+/* Not possible on Android */
 }
 /*
 * Gets the size the system thinks the widget should be.
 * Parameters:
 *          horz: DW_GRAV_LEFT (default), DW_GRAV_RIGHT or DW_GRAV_CENTER.
 *          vert: DW_GRAV_TOP (default), DW_GRAV_BOTTOM or DW_GRAV_CENTER.
 */
 void API dw_window_set_gravity(HWND handle, int horz, int vert)
 {
+/* This is not possible on Android */
 }
 /*
 * Sets the position of a given window (widget).
 * Parameters:
 *          x: X location from the bottom left.
 *          y: Y location from the bottom left.
 */
 void API dw_window_set_pos(HWND handle, LONG x, LONG y)
 {
+/* This is not possible on Android */
 }
 /*
 * Sets the position and size of a given window (widget).
 * Parameters:
 *          width: Width of the widget.
 *          height: Height of the widget.
 */
 void API dw_window_set_pos_size(HWND handle, LONG x, LONG y, ULONG width, ULONG height)
 {
+/* This is not possible on Android */
 }
 /*
 * Gets the position and size of a given window (widget).
 * Parameters:
 * Returns:
 *       A handle to the print object or nullptr on failure.
 */
 HPRINT API dw_print_new(const char *jobname, unsigned long flags, unsigned int pages, void *drawfunc, void *drawdata)
 {
+/* TODO: Implement printing */
 return nullptr;
 }
 /*
 * Runs the print job, causing the draw page callbacks to fire.
 * Returns:
 *       DW_ERROR_UNKNOWN on error or DW_ERROR_NONE on success.
 */
 int API dw_print_run(HPRINT print, unsigned long flags)
 {
+/* TODO: Implement printing */
 return DW_ERROR_UNKNOWN;
 }
 /*
 * Cancels the print job, typically called from a draw page callback.
 * Parameters:
 *       print: Handle to the print object returned by dw_print_new().
 */
 void API dw_print_cancel(HPRINT print)
 {
+/* TODO: Implement printing */
 }
 /*
 * Creates a new system notification if possible.
 * Parameters:

Mercurial > dwindows

comparison android/dw.cpp @ 2710:98cc4476b376