summaryrefslogtreecommitdiff
path: root/src/lib/ecore_cocoa
diff options
context:
space:
mode:
authorJean Guyomarc'h <jean.guyomarch@gmail.com>2016-01-22 21:08:40 +0100
committerCedric BAIL <cedric@osg.samsung.com>2016-03-02 13:56:49 -0800
commit0ceca701bf3b8f1e6828f1e356fbbdff89281571 (patch)
tree3351cc3210b50aa7853ded8ae98b83aeba38e4fa /src/lib/ecore_cocoa
parentaca6fc8c3611b5e7d4faaed61e52dedf057d7219 (diff)
ecore_cocoa: add function attributes
Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/ecore_cocoa')
-rw-r--r--src/lib/ecore_cocoa/Ecore_Cocoa.h81
1 files changed, 56 insertions, 25 deletions
diff --git a/src/lib/ecore_cocoa/Ecore_Cocoa.h b/src/lib/ecore_cocoa/Ecore_Cocoa.h
index 5b05129738..1e73b7fe9e 100644
--- a/src/lib/ecore_cocoa/Ecore_Cocoa.h
+++ b/src/lib/ecore_cocoa/Ecore_Cocoa.h
@@ -226,13 +226,16 @@ EAPI void ecore_cocoa_screen_size_get(Ecore_Cocoa_Screen *screen, int *w, int *h
226EAPI Ecore_Cocoa_Window *ecore_cocoa_window_new(int x, 226EAPI Ecore_Cocoa_Window *ecore_cocoa_window_new(int x,
227 int y, 227 int y,
228 int w, 228 int w,
229 int h); 229 int h)
230 EINA_MALLOC
231 EINA_WARN_UNUSED_RESULT;
230 232
231/** 233/**
232 * Releases a Cocoa window 234 * Releases a Cocoa window
233 * @param window The window to be released 235 * @param window The window to be released
234 */ 236 */
235EAPI void ecore_cocoa_window_free(Ecore_Cocoa_Window *window); 237EAPI void ecore_cocoa_window_free(Ecore_Cocoa_Window *window)
238 EINA_ARG_NONNULL(1);
236 239
237/** 240/**
238 * Moves a Cocoa window at a given point 241 * Moves a Cocoa window at a given point
@@ -242,7 +245,8 @@ EAPI void ecore_cocoa_window_free(Ecore_Cocoa_Window *window);
242 */ 245 */
243EAPI void ecore_cocoa_window_move(Ecore_Cocoa_Window *window, 246EAPI void ecore_cocoa_window_move(Ecore_Cocoa_Window *window,
244 int x, 247 int x,
245 int y); 248 int y)
249 EINA_ARG_NONNULL(1);
246 250
247/** 251/**
248 * Resizes a Cocoa window to a given size 252 * Resizes a Cocoa window to a given size
@@ -252,7 +256,8 @@ EAPI void ecore_cocoa_window_move(Ecore_Cocoa_Window *window,
252 */ 256 */
253EAPI void ecore_cocoa_window_resize(Ecore_Cocoa_Window *window, 257EAPI void ecore_cocoa_window_resize(Ecore_Cocoa_Window *window,
254 int w, 258 int w,
255 int h); 259 int h)
260 EINA_ARG_NONNULL(1);
256 261
257/** 262/**
258 * Moves and resizes a Cocoa window to a given point and size 263 * Moves and resizes a Cocoa window to a given point and size
@@ -269,7 +274,8 @@ EAPI void ecore_cocoa_window_move_resize(Ecore_Cocoa_Window *window,
269 int x, 274 int x,
270 int y, 275 int y,
271 int w, 276 int w,
272 int h); 277 int h)
278 EINA_ARG_NONNULL(1);
273 279
274/** 280/**
275 * Gets the geometry of a Cocoa window 281 * Gets the geometry of a Cocoa window
@@ -283,7 +289,8 @@ EAPI void ecore_cocoa_window_geometry_get(const Ecore_Cocoa_Window *window,
283 int *x, 289 int *x,
284 int *y, 290 int *y,
285 int *w, 291 int *w,
286 int *h); 292 int *h)
293 EINA_ARG_NONNULL(1);
287 294
288/** 295/**
289 * Gets the size of a Cocoa window 296 * Gets the size of a Cocoa window
@@ -293,7 +300,8 @@ EAPI void ecore_cocoa_window_geometry_get(const Ecore_Cocoa_Window *window,
293 */ 300 */
294EAPI void ecore_cocoa_window_size_get(const Ecore_Cocoa_Window *window, 301EAPI void ecore_cocoa_window_size_get(const Ecore_Cocoa_Window *window,
295 int *w, 302 int *w,
296 int *h); 303 int *h)
304 EINA_ARG_NONNULL(1);
297 305
298/** 306/**
299 * Sets the minimum size of a Cocoa window 307 * Sets the minimum size of a Cocoa window
@@ -303,7 +311,8 @@ EAPI void ecore_cocoa_window_size_get(const Ecore_Cocoa_Window *window,
303 */ 311 */
304EAPI void ecore_cocoa_window_size_min_set(Ecore_Cocoa_Window *window, 312EAPI void ecore_cocoa_window_size_min_set(Ecore_Cocoa_Window *window,
305 int w, 313 int w,
306 int h); 314 int h)
315 EINA_ARG_NONNULL(1);
307 316
308/** 317/**
309 * Gets the minimum size size of a Cocoa window 318 * Gets the minimum size size of a Cocoa window
@@ -313,7 +322,8 @@ EAPI void ecore_cocoa_window_size_min_set(Ecore_Cocoa_Window *window,
313 */ 322 */
314EAPI void ecore_cocoa_window_size_min_get(const Ecore_Cocoa_Window *window, 323EAPI void ecore_cocoa_window_size_min_get(const Ecore_Cocoa_Window *window,
315 int *w, 324 int *w,
316 int *h); 325 int *h)
326 EINA_ARG_NONNULL(1);
317 327
318/** 328/**
319 * Sets the maximum size of a Cocoa window 329 * Sets the maximum size of a Cocoa window
@@ -323,7 +333,8 @@ EAPI void ecore_cocoa_window_size_min_get(const Ecore_Cocoa_Window *window,
323 */ 333 */
324EAPI void ecore_cocoa_window_size_max_set(Ecore_Cocoa_Window *window, 334EAPI void ecore_cocoa_window_size_max_set(Ecore_Cocoa_Window *window,
325 int w, 335 int w,
326 int h); 336 int h)
337 EINA_ARG_NONNULL(1);
327 338
328/** 339/**
329 * Gets the maximum size size of a Cocoa window 340 * Gets the maximum size size of a Cocoa window
@@ -333,7 +344,8 @@ EAPI void ecore_cocoa_window_size_max_set(Ecore_Cocoa_Window *window,
333 */ 344 */
334EAPI void ecore_cocoa_window_size_max_get(const Ecore_Cocoa_Window *window, 345EAPI void ecore_cocoa_window_size_max_get(const Ecore_Cocoa_Window *window,
335 int *w, 346 int *w,
336 int *h); 347 int *h)
348 EINA_ARG_NONNULL(1);
337 349
338/** 350/**
339 * Set a Cocoa window's resize increment 351 * Set a Cocoa window's resize increment
@@ -343,7 +355,9 @@ EAPI void ecore_cocoa_window_size_max_get(const Ecore_Cocoa_Window *window,
343 */ 355 */
344EAPI void ecore_cocoa_window_size_step_set(Ecore_Cocoa_Window *window, 356EAPI void ecore_cocoa_window_size_step_set(Ecore_Cocoa_Window *window,
345 int w, 357 int w,
346 int h); 358 int h)
359 EINA_ARG_NONNULL(1);
360
347/** 361/**
348 * Get a Cocoa window's resize increment 362 * Get a Cocoa window's resize increment
349 * @param window The Cocoa window which resize increment queried 363 * @param window The Cocoa window which resize increment queried
@@ -352,37 +366,43 @@ EAPI void ecore_cocoa_window_size_step_set(Ecore_Cocoa_Window *window,
352 */ 366 */
353EAPI void ecore_cocoa_window_size_step_get(const Ecore_Cocoa_Window *window, 367EAPI void ecore_cocoa_window_size_step_get(const Ecore_Cocoa_Window *window,
354 int *w, 368 int *w,
355 int *h); 369 int *h)
370 EINA_ARG_NONNULL(1);
356 371
357/** 372/**
358 * Display a Cocoa window 373 * Display a Cocoa window
359 * @param window The Cocoa window to be displayed 374 * @param window The Cocoa window to be displayed
360 */ 375 */
361EAPI void ecore_cocoa_window_show(Ecore_Cocoa_Window *window); 376EAPI void ecore_cocoa_window_show(Ecore_Cocoa_Window *window)
377 EINA_ARG_NONNULL(1);
362 378
363/** 379/**
364 * Hide a Cocoa window 380 * Hide a Cocoa window
365 * @param window The Cocoa window to be hid 381 * @param window The Cocoa window to be hid
366 */ 382 */
367EAPI void ecore_cocoa_window_hide(Ecore_Cocoa_Window *window); 383EAPI void ecore_cocoa_window_hide(Ecore_Cocoa_Window *window)
384 EINA_ARG_NONNULL(1);
368 385
369/** 386/**
370 * Brings a Cocoa window to front 387 * Brings a Cocoa window to front
371 * @param window The Cocoa window to be raised 388 * @param window The Cocoa window to be raised
372 */ 389 */
373EAPI void ecore_cocoa_window_raise(Ecore_Cocoa_Window *window); 390EAPI void ecore_cocoa_window_raise(Ecore_Cocoa_Window *window)
391 EINA_ARG_NONNULL(1);
374 392
375/** 393/**
376 * Brings a Cocoa window back 394 * Brings a Cocoa window back
377 * @param window The Cocoa window to be lowered 395 * @param window The Cocoa window to be lowered
378 */ 396 */
379EAPI void ecore_cocoa_window_lower(Ecore_Cocoa_Window *window); 397EAPI void ecore_cocoa_window_lower(Ecore_Cocoa_Window *window)
398 EINA_ARG_NONNULL(1);
380 399
381/** 400/**
382 * Makes a Cocoa window the current key window by raising it 401 * Makes a Cocoa window the current key window by raising it
383 * @param window The Cocoa window to be activated 402 * @param window The Cocoa window to be activated
384 */ 403 */
385EAPI void ecore_cocoa_window_activate(Ecore_Cocoa_Window *window); 404EAPI void ecore_cocoa_window_activate(Ecore_Cocoa_Window *window)
405 EINA_ARG_NONNULL(1);
386 406
387/** 407/**
388 * Changes the title of a Cocoa window 408 * Changes the title of a Cocoa window
@@ -390,7 +410,8 @@ EAPI void ecore_cocoa_window_activate(Ecore_Cocoa_Window *window);
390 * @param title The new title of the Cocoa window 410 * @param title The new title of the Cocoa window
391 */ 411 */
392EAPI void ecore_cocoa_window_title_set(Ecore_Cocoa_Window *window, 412EAPI void ecore_cocoa_window_title_set(Ecore_Cocoa_Window *window,
393 const char *title); 413 const char *title)
414 EINA_ARG_NONNULL(1);
394 415
395/** 416/**
396 * Miniaturize or deminiaturize a Cocoa window 417 * Miniaturize or deminiaturize a Cocoa window
@@ -398,7 +419,8 @@ EAPI void ecore_cocoa_window_title_set(Ecore_Cocoa_Window *window,
398 * @param on If #EINA_TRUE, will miniaturize the window. Will deminiaturize it if #EINA_FALSE 419 * @param on If #EINA_TRUE, will miniaturize the window. Will deminiaturize it if #EINA_FALSE
399 */ 420 */
400EAPI void ecore_cocoa_window_iconified_set(Ecore_Cocoa_Window *window, 421EAPI void ecore_cocoa_window_iconified_set(Ecore_Cocoa_Window *window,
401 Eina_Bool on); 422 Eina_Bool on)
423 EINA_ARG_NONNULL(1);
402 424
403/** 425/**
404 * Manage the borders of a Cocoa window 426 * Manage the borders of a Cocoa window
@@ -406,7 +428,8 @@ EAPI void ecore_cocoa_window_iconified_set(Ecore_Cocoa_Window *window,
406 * @param on If #EINA_TRUE, will remove borders. Will restore them if #EINA_FALSE 428 * @param on If #EINA_TRUE, will remove borders. Will restore them if #EINA_FALSE
407 */ 429 */
408EAPI void ecore_cocoa_window_borderless_set(Ecore_Cocoa_Window *window, 430EAPI void ecore_cocoa_window_borderless_set(Ecore_Cocoa_Window *window,
409 Eina_Bool on); 431 Eina_Bool on)
432 EINA_ARG_NONNULL(1);
410 433
411/** 434/**
412 * Set the content view of a Cocoa window 435 * Set the content view of a Cocoa window
@@ -414,7 +437,9 @@ EAPI void ecore_cocoa_window_borderless_set(Ecore_Cocoa_Window *window,
414 * @param view The NSView to be set as @c window content view 437 * @param view The NSView to be set as @c window content view
415 */ 438 */
416EAPI void ecore_cocoa_window_view_set(Ecore_Cocoa_Window *window, 439EAPI void ecore_cocoa_window_view_set(Ecore_Cocoa_Window *window,
417 Ecore_Cocoa_Object *view); 440 Ecore_Cocoa_Object *view)
441 EINA_ARG_NONNULL(1)
442 EINA_ARG_NONNULL(2);
418 443
419/** 444/**
420 * Get the height of the title bar of Cocoa windows 445 * Get the height of the title bar of Cocoa windows
@@ -427,7 +452,9 @@ EAPI int ecore_cocoa_titlebar_height_get(void);
427 * @param window The Ecore_Cocoa wrapper which window is to be retrieved 452 * @param window The Ecore_Cocoa wrapper which window is to be retrieved
428 * @return The Cocoa NSWindow manipulated by @c window 453 * @return The Cocoa NSWindow manipulated by @c window
429 */ 454 */
430EAPI Ecore_Cocoa_Object *ecore_cocoa_window_get(const Ecore_Cocoa_Window *window); 455EAPI Ecore_Cocoa_Object *ecore_cocoa_window_get(const Ecore_Cocoa_Window *window)
456 EINA_ARG_NONNULL(1)
457 EINA_WARN_UNUSED_RESULT;
431 458
432/** 459/**
433 * Set the clipboard of Cocoa (NSPasteboard) 460 * Set the clipboard of Cocoa (NSPasteboard)
@@ -453,7 +480,8 @@ EAPI Eina_Bool ecore_cocoa_selection_clipboard_set(const void *data,
453 */ 480 */
454EAPI void *ecore_cocoa_selection_clipboard_get(int *size, 481EAPI void *ecore_cocoa_selection_clipboard_get(int *size,
455 Ecore_Cocoa_Cnp_Type type, 482 Ecore_Cocoa_Cnp_Type type,
456 Ecore_Cocoa_Cnp_Type *retrieved_types); 483 Ecore_Cocoa_Cnp_Type *retrieved_types)
484 EINA_WARN_UNUSED_RESULT;
457 485
458/** 486/**
459 * Deletes the contents of the Cocoa clipboard 487 * Deletes the contents of the Cocoa clipboard
@@ -465,7 +493,9 @@ EAPI void ecore_cocoa_selection_clipboard_clear(void);
465 * @param win The Cocoa window on which the cursor is to be changed. 493 * @param win The Cocoa window on which the cursor is to be changed.
466 * @param c The cursor to be set 494 * @param c The cursor to be set
467 */ 495 */
468EAPI void ecore_cocoa_window_cursor_set(Ecore_Cocoa_Window *win, Ecore_Cocoa_Cursor c); 496EAPI void ecore_cocoa_window_cursor_set(Ecore_Cocoa_Window *win,
497 Ecore_Cocoa_Cursor c)
498 EINA_ARG_NONNULL(1);
469 499
470/** 500/**
471 * Hide or show the Cocoa cursor for a given Cocoa window 501 * Hide or show the Cocoa cursor for a given Cocoa window
@@ -474,6 +504,7 @@ EAPI void ecore_cocoa_window_cursor_set(Ecore_Cocoa_Window *win, Ecore_Cocoa_Cur
474 * 504 *
475 */ 505 */
476EAPI void ecore_cocoa_window_cursor_show(Ecore_Cocoa_Window *win, Eina_Bool show); 506EAPI void ecore_cocoa_window_cursor_show(Ecore_Cocoa_Window *win, Eina_Bool show);
507 EINA_ARG_NONNULL(1);
477 508
478#ifdef __cplusplus 509#ifdef __cplusplus
479} 510}