gimpbuffer_pdb.c 6.82 KB
Newer Older
1 2 3 4 5
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
 *
 * gimpbuffer_pdb.c
 *
6
 * This library is free software: you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 14 15 16
 *
 * 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
 * Lesser General Public License for more details.
 *
 * 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 */
22 23 24 25 26

#include "config.h"

#include "gimp.h"

27 28 29 30 31 32 33 34 35 36

/**
 * SECTION: gimpbuffer
 * @title: gimpbuffer
 * @short_description: Functions for manipulating cut buffers.
 *
 * Functions related to named cut buffers.
 **/


37 38 39 40 41 42 43 44 45 46
/**
 * gimp_buffers_get_list:
 * @filter: An optional regular expression used to filter the list.
 * @num_buffers: The number of buffers.
 *
 * Retrieve a complete listing of the available buffers.
 *
 * This procedure returns a complete listing of available named
 * buffers.
 *
47 48
 * Returns: The list of buffer names. The returned value must be freed
 * with g_strfreev().
49
 *
50
 * Since: 2.4
51
 **/
52 53
gchar **
gimp_buffers_get_list (const gchar *filter,
54
                       gint        *num_buffers)
55 56 57 58 59 60 61
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gchar **buffer_list = NULL;
  gint i;

  return_vals = gimp_run_procedure ("gimp-buffers-get-list",
62 63 64
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, filter,
                                    GIMP_PDB_END);
65 66 67 68 69 70

  *num_buffers = 0;

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    {
      *num_buffers = return_vals[1].data.d_int32;
71 72 73 74 75 76
      if (*num_buffers > 0)
        {
          buffer_list = g_new0 (gchar *, *num_buffers + 1);
          for (i = 0; i < *num_buffers; i++)
            buffer_list[i] = g_strdup (return_vals[2].data.d_stringarray[i]);
        }
77 78 79 80 81 82 83
    }

  gimp_destroy_params (return_vals, nreturn_vals);

  return buffer_list;
}

84 85 86 87 88 89 90 91 92 93 94
/**
 * gimp_buffer_rename:
 * @buffer_name: The buffer name.
 * @new_name: The buffer's new name.
 *
 * Renames a named buffer.
 *
 * This procedure renames a named buffer.
 *
 * Returns: The real name given to the buffer.
 *
95
 * Since: 2.4
96
 **/
97 98
gchar *
gimp_buffer_rename (const gchar *buffer_name,
99
                    const gchar *new_name)
100 101 102 103 104 105
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gchar *real_name = NULL;

  return_vals = gimp_run_procedure ("gimp-buffer-rename",
106 107 108 109
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, buffer_name,
                                    GIMP_PDB_STRING, new_name,
                                    GIMP_PDB_END);
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    real_name = g_strdup (return_vals[1].data.d_string);

  gimp_destroy_params (return_vals, nreturn_vals);

  return real_name;
}

/**
 * gimp_buffer_delete:
 * @buffer_name: The buffer name.
 *
 * Deletes a named buffer.
 *
 * This procedure deletes a named buffer.
 *
 * Returns: TRUE on success.
 *
129
 * Since: 2.4
130
 **/
131 132 133 134 135 136 137 138
gboolean
gimp_buffer_delete (const gchar *buffer_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

  return_vals = gimp_run_procedure ("gimp-buffer-delete",
139 140 141
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, buffer_name,
                                    GIMP_PDB_END);
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

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

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_buffer_get_width:
 * @buffer_name: The buffer name.
 *
 * Retrieves the specified buffer's width.
 *
 * This procedure retrieves the specified named buffer's width.
 *
 * Returns: The buffer width.
 *
160
 * Since: 2.4
161
 **/
162 163 164 165 166 167 168 169
gint
gimp_buffer_get_width (const gchar *buffer_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint width = 0;

  return_vals = gimp_run_procedure ("gimp-buffer-get-width",
170 171 172
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, buffer_name,
                                    GIMP_PDB_END);
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

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

  gimp_destroy_params (return_vals, nreturn_vals);

  return width;
}

/**
 * gimp_buffer_get_height:
 * @buffer_name: The buffer name.
 *
 * Retrieves the specified buffer's height.
 *
 * This procedure retrieves the specified named buffer's height.
 *
 * Returns: The buffer height.
 *
192
 * Since: 2.4
193
 **/
194 195 196 197 198 199 200 201
gint
gimp_buffer_get_height (const gchar *buffer_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint height = 0;

  return_vals = gimp_run_procedure ("gimp-buffer-get-height",
202 203 204
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, buffer_name,
                                    GIMP_PDB_END);
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

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

  gimp_destroy_params (return_vals, nreturn_vals);

  return height;
}

/**
 * gimp_buffer_get_bytes:
 * @buffer_name: The buffer name.
 *
 * Retrieves the specified buffer's bytes.
 *
 * This procedure retrieves the specified named buffer's bytes.
 *
 * Returns: The buffer bpp.
 *
224
 * Since: 2.4
225
 **/
226 227 228 229 230 231 232 233
gint
gimp_buffer_get_bytes (const gchar *buffer_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint bytes = 0;

  return_vals = gimp_run_procedure ("gimp-buffer-get-bytes",
234 235 236
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, buffer_name,
                                    GIMP_PDB_END);
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255

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

  gimp_destroy_params (return_vals, nreturn_vals);

  return bytes;
}

/**
 * gimp_buffer_get_image_type:
 * @buffer_name: The buffer name.
 *
 * Retrieves the specified buffer's image type.
 *
 * This procedure retrieves the specified named buffer's image type.
 *
 * Returns: The buffer image type.
 *
256
 * Since: 2.4
257
 **/
258 259 260 261 262 263 264 265
GimpImageBaseType
gimp_buffer_get_image_type (const gchar *buffer_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  GimpImageBaseType image_type = 0;

  return_vals = gimp_run_procedure ("gimp-buffer-get-image-type",
266 267 268
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, buffer_name,
                                    GIMP_PDB_END);
269 270 271 272 273 274 275 276

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

  gimp_destroy_params (return_vals, nreturn_vals);

  return image_type;
}