gmain.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /* GLIB - Library of useful routines for C programming
  2. * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
  3. *
  4. * This library is free software; you can redistribute it and/or
  5. * modify it under the terms of the GNU Lesser General Public
  6. * License as published by the Free Software Foundation; either
  7. * version 2 of the License, or (at your option) any later version.
  8. *
  9. * This library is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. * Lesser General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU Lesser General Public
  15. * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16. */
  17. /*
  18. * Modified by the GLib Team and others 1997-2000. See the AUTHORS
  19. * file for a list of people on the GLib Team. See the ChangeLog
  20. * files for a list of changes. These files are distributed with
  21. * GLib at ftp://ftp.gtk.org/pub/gtk/.
  22. */
  23. #ifndef __G_DEPRECATED_MAIN_H__
  24. #define __G_DEPRECATED_MAIN_H__
  25. #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  26. #error "Only <glib.h> can be included directly."
  27. #endif
  28. #include <glib/gmain.h>
  29. G_BEGIN_DECLS
  30. #ifndef G_DISABLE_DEPRECATED
  31. /* ============== Compat main loop stuff ================== */
  32. /**
  33. * g_main_new:
  34. * @is_running: set to %TRUE to indicate that the loop is running. This
  35. * is not very important since calling g_main_run() will set this
  36. * to %TRUE anyway.
  37. *
  38. * Creates a new #GMainLoop for th default main context.
  39. *
  40. * Returns: a new #GMainLoop
  41. *
  42. * Deprecated: 2.2: Use g_main_loop_new() instead
  43. */
  44. #define g_main_new(is_running) g_main_loop_new (NULL, is_running)
  45. /**
  46. * g_main_run:
  47. * @loop: a #GMainLoop
  48. *
  49. * Runs a main loop until it stops running.
  50. *
  51. * Deprecated: 2.2: Use g_main_loop_run() instead
  52. */
  53. #define g_main_run(loop) g_main_loop_run(loop)
  54. /**
  55. * g_main_quit:
  56. * @loop: a #GMainLoop
  57. *
  58. * Stops the #GMainLoop.
  59. * If g_main_run() was called to run the #GMainLoop, it will now return.
  60. *
  61. * Deprecated: 2.2: Use g_main_loop_quit() instead
  62. */
  63. #define g_main_quit(loop) g_main_loop_quit(loop)
  64. /**
  65. * g_main_destroy:
  66. * @loop: a #GMainLoop
  67. *
  68. * Frees the memory allocated for the #GMainLoop.
  69. *
  70. * Deprecated: 2.2: Use g_main_loop_unref() instead
  71. */
  72. #define g_main_destroy(loop) g_main_loop_unref(loop)
  73. /**
  74. * g_main_is_running:
  75. * @loop: a #GMainLoop
  76. *
  77. * Checks if the main loop is running.
  78. *
  79. * Returns: %TRUE if the main loop is running
  80. *
  81. * Deprecated: 2.2: Use g_main_loop_is_running() instead
  82. */
  83. #define g_main_is_running(loop) g_main_loop_is_running(loop)
  84. /**
  85. * g_main_iteration:
  86. * @may_block: set to %TRUE if it should block (i.e. wait) until an event
  87. * source becomes ready. It will return after an event source has been
  88. * processed. If set to %FALSE it will return immediately if no event
  89. * source is ready to be processed.
  90. *
  91. * Runs a single iteration for the default #GMainContext.
  92. *
  93. * Returns: %TRUE if more events are pending.
  94. *
  95. * Deprecated: 2.2: Use g_main_context_iteration() instead.
  96. */
  97. #define g_main_iteration(may_block) g_main_context_iteration (NULL, may_block)
  98. /**
  99. * g_main_pending:
  100. *
  101. * Checks if any events are pending for the default #GMainContext
  102. * (i.e. ready to be processed).
  103. *
  104. * Returns: %TRUE if any events are pending.
  105. *
  106. * Deprected: 2.2: Use g_main_context_pending() instead.
  107. */
  108. #define g_main_pending() g_main_context_pending (NULL)
  109. /**
  110. * g_main_set_poll_func:
  111. * @func: the function to call to poll all file descriptors
  112. *
  113. * Sets the function to use for the handle polling of file descriptors
  114. * for the default main context.
  115. *
  116. * Deprecated: 2.2: Use g_main_context_set_poll_func() again
  117. */
  118. #define g_main_set_poll_func(func) g_main_context_set_poll_func (NULL, func)
  119. #endif
  120. G_END_DECLS
  121. #endif /* __G_DEPRECATED_MAIN_H__ */