gimpdisplay_pdb.c 6.7 KB
Newer Older
1
/* LIBGIMP - The GIMP Library
2
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
3 4
 *
 * gimpdisplay_pdb.c
Manish Singh's avatar
Manish Singh committed
5
 *
6
 * This library is free software: you can redistribute it and/or
Marc Lehmann's avatar
Marc Lehmann committed
7
 * modify it under the terms of the GNU Lesser General Public
Manish Singh's avatar
Manish Singh committed
8
 * License as published by the Free Software Foundation; either
9
 * version 3 of the License, or (at your option) any later version.
10 11 12 13
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
Manish Singh's avatar
Manish Singh committed
15
 *
Marc Lehmann's avatar
Marc Lehmann committed
16
 * You should have received a copy of the GNU Lesser General Public
17 18
 * License along with this library.  If not, see
 * <http://www.gnu.org/licenses/>.
19 20
 */

21
/* NOTE: This file is auto-generated by pdbgen.pl */
Elliot Lee's avatar
Elliot Lee committed
22

Sven Neumann's avatar
Sven Neumann committed
23 24
#include "config.h"

25
#include "gimp.h"
Elliot Lee's avatar
Elliot Lee committed
26

27 28 29 30 31 32 33 34 35 36

/**
 * SECTION: gimpdisplay
 * @title: gimpdisplay
 * @short_description: Functions to create, delete and flush displays (views) on an image.
 *
 * Functions to create, delete and flush displays (views) on an image.
 **/


37 38 39 40 41 42 43 44 45 46 47
/**
 * gimp_display_is_valid:
 * @display_ID: The display to check.
 *
 * Returns TRUE if the display is valid.
 *
 * This procedure checks if the given display ID is valid and refers to
 * an existing display.
 *
 * Returns: Whether the display ID is valid.
 *
48
 * Since: 2.4
49
 **/
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
gboolean
gimp_display_is_valid (gint32 display_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean valid = FALSE;

  return_vals = gimp_run_procedure ("gimp-display-is-valid",
                                    &nreturn_vals,
                                    GIMP_PDB_DISPLAY, display_ID,
                                    GIMP_PDB_END);

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    valid = return_vals[1].data.d_int32;

  gimp_destroy_params (return_vals, nreturn_vals);

  return valid;
}

70 71 72 73 74 75 76 77
/**
 * gimp_display_new:
 * @image_ID: The image.
 *
 * Create a new display for the specified image.
 *
 * Creates a new display for the specified image. If the image already
 * has a display, another is added. Multiple displays are handled
78 79
 * transparently by GIMP. The newly created display is returned and can
 * be subsequently destroyed with a call to gimp_display_delete(). This
80 81
 * procedure only makes sense for use with the GIMP UI, and will result
 * in an execution error if called when GIMP has no UI.
82 83
 *
 * Returns: The new display.
84
 **/
Elliot Lee's avatar
Elliot Lee committed
85 86 87
gint32
gimp_display_new (gint32 image_ID)
{
88
  GimpParam *return_vals;
89
  gint nreturn_vals;
90
  gint32 display_ID = -1;
Elliot Lee's avatar
Elliot Lee committed
91

92
  return_vals = gimp_run_procedure ("gimp-display-new",
93 94 95
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
Elliot Lee's avatar
Elliot Lee committed
96

97
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
Elliot Lee's avatar
Elliot Lee committed
98 99 100 101 102 103 104
    display_ID = return_vals[1].data.d_display;

  gimp_destroy_params (return_vals, nreturn_vals);

  return display_ID;
}

105 106 107 108 109 110 111 112
/**
 * gimp_display_delete:
 * @display_ID: The display to delete.
 *
 * Delete the specified display.
 *
 * This procedure removes the specified display. If this is the last
 * remaining display for the underlying image, then the image is
113 114 115
 * deleted also. Note that the display is closed no matter if the image
 * is dirty or not. Better save the image before calling this
 * procedure.
116 117
 *
 * Returns: TRUE on success.
118
 **/
119
gboolean
Elliot Lee's avatar
Elliot Lee committed
120 121
gimp_display_delete (gint32 display_ID)
{
122
  GimpParam *return_vals;
123
  gint nreturn_vals;
124
  gboolean success = TRUE;
Elliot Lee's avatar
Elliot Lee committed
125

126
  return_vals = gimp_run_procedure ("gimp-display-delete",
127 128 129
                                    &nreturn_vals,
                                    GIMP_PDB_DISPLAY, display_ID,
                                    GIMP_PDB_END);
Elliot Lee's avatar
Elliot Lee committed
130

131 132
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

Elliot Lee's avatar
Elliot Lee committed
133
  gimp_destroy_params (return_vals, nreturn_vals);
134 135

  return success;
Elliot Lee's avatar
Elliot Lee committed
136 137
}

Sven Neumann's avatar
Sven Neumann committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151
/**
 * gimp_display_get_window_handle:
 * @display_ID: The display to get the window handle from.
 *
 * Get a handle to the native window for an image display.
 *
 * This procedure returns a handle to the native window for a given
 * image display. For example in the X backend of GDK, a native window
 * handle is an Xlib XID. A value of 0 is returned for an invalid
 * display or if this function is unimplemented for the windowing
 * system that is being used.
 *
 * Returns: The native window handle or 0.
 *
152
 * Since: 2.4
153
 **/
Sven Neumann's avatar
Sven Neumann committed
154 155 156 157 158 159 160 161
gint
gimp_display_get_window_handle (gint32 display_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint window = 0;

  return_vals = gimp_run_procedure ("gimp-display-get-window-handle",
162 163 164
                                    &nreturn_vals,
                                    GIMP_PDB_DISPLAY, display_ID,
                                    GIMP_PDB_END);
Sven Neumann's avatar
Sven Neumann committed
165 166 167 168 169 170 171 172 173

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    window = return_vals[1].data.d_int32;

  gimp_destroy_params (return_vals, nreturn_vals);

  return window;
}

174 175 176 177 178 179 180 181 182 183 184
/**
 * gimp_displays_flush:
 *
 * Flush all internal changes to the user interface
 *
 * This procedure takes no arguments and returns nothing except a
 * success status. Its purpose is to flush all pending updates of image
 * manipulations to the user interface. It should be called whenever
 * appropriate.
 *
 * Returns: TRUE on success.
185
 **/
186
gboolean
187
gimp_displays_flush (void)
Elliot Lee's avatar
Elliot Lee committed
188
{
189
  GimpParam *return_vals;
190
  gint nreturn_vals;
191
  gboolean success = TRUE;
Elliot Lee's avatar
Elliot Lee committed
192

193
  return_vals = gimp_run_procedure ("gimp-displays-flush",
194 195
                                    &nreturn_vals,
                                    GIMP_PDB_END);
Elliot Lee's avatar
Elliot Lee committed
196

197 198
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

Elliot Lee's avatar
Elliot Lee committed
199
  gimp_destroy_params (return_vals, nreturn_vals);
200 201

  return success;
Elliot Lee's avatar
Elliot Lee committed
202
}
203 204 205

/**
 * gimp_displays_reconnect:
206
 * @old_image_ID: The old image (must have at least one display).
207 208 209 210 211
 * @new_image_ID: The new image (must not have a display).
 *
 * Reconnect displays from one image to another image.
 *
 * This procedure connects all displays of the old_image to the
212 213 214
 * new_image. If the old_image has no display or new_image already has
 * a display the reconnect is not performed and the procedure returns
 * without success. You should rarely need to use this function.
215 216
 *
 * Returns: TRUE on success.
217
 **/
218 219
gboolean
gimp_displays_reconnect (gint32 old_image_ID,
220
                         gint32 new_image_ID)
221 222 223 224 225
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

226
  return_vals = gimp_run_procedure ("gimp-displays-reconnect",
227 228 229 230
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, old_image_ID,
                                    GIMP_PDB_IMAGE, new_image_ID,
                                    GIMP_PDB_END);
231 232 233 234 235 236 237

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}