Ecore_Cocoa.h(3)

NAME
Ecore_Cocoa.h - Ecore_Cocoa Wrapper Library to interact with the Cocoa environment (Mac OS X) from the E environment.

SYNOPSIS

  Data Structures
struct _Ecore_Cocoa_Event_Window_Resize_Request
Data available when a window is resized.
struct _Ecore_Cocoa_Event_Window_Focused
Data available when a Cocoa window receives focus.
struct _Ecore_Cocoa_Event_Window_Unfocused
Data available when a Cocoa window losrs focus.
struct _Ecore_Cocoa_Event_Window_Destroy
Data available when a Cocoa window is destroyed.

  Macros
#define EAPI
#define ECORE_COCOA_CURSOR_DEFAULT ECORE_COCOA_CURSOR_ARROW
Defines the default Cocoa cursor, to be used when nothing is specified or as a fallback.
#define EAPI

  Typedefs
typedef struct _Ecore_Cocoa_Window Ecore_Cocoa_Window
Opaque handler to manipulate a Cocoa Window through Ecore.
typedef struct _Ecore_Cocoa_Screen Ecore_Cocoa_Screen
Opaque handler to manipulate a Cocoa Screen through Ecore.
typedef void Ecore_Cocoa_Object
Opaque handler to refer to an objective-c object (a.k.a.
typedef struct _Ecore_Cocoa_Event_Window_Resize_Request Ecore_Cocoa_Event_Window_Resize_Request
Type of event thrown when a Cocoa window is resized.
typedef struct _Ecore_Cocoa_Event_Window_Focused Ecore_Cocoa_Event_Window_Focused
Type of event thrown when a Cocoa window receives focus.
typedef struct _Ecore_Cocoa_Event_Window_Unfocused Ecore_Cocoa_Event_Window_Unfocused
Type of event thrown when a Cocoa window loses the focus.
typedef struct _Ecore_Cocoa_Event_Window_Destroy Ecore_Cocoa_Event_Window_Destroy
Type of event thrown when a Cocoa window gets destoyed.
typedef Eina_Bool(* Ecore_Cocoa_Terminate_Cb) (Ecore_Cocoa_Object *sender)
Callback called when a delete request is sent to the application.

  Enumerations
enum Ecore_Cocoa_Cursor { ECORE_COCOA_CURSOR_ARROW = 0, ECORE_COCOA_CURSOR_CONTEXTUAL_MENU, ECORE_COCOA_CURSOR_CLOSED_HAND, ECORE_COCOA_CURSOR_CROSSHAIR, ECORE_COCOA_CURSOR_DISAPPEARING_ITEM, ECORE_COCOA_CURSOR_DRAG_COPY, ECORE_COCOA_CURSOR_DRAG_LINK, ECORE_COCOA_CURSOR_IBEAM, ECORE_COCOA_CURSOR_OPEN_HAND, ECORE_COCOA_CURSOR_OPERATION_NOT_ALLOWED, ECORE_COCOA_CURSOR_POINTING_HAND, ECORE_COCOA_CURSOR_RESIZE_DOWN, ECORE_COCOA_CURSOR_RESIZE_LEFT, ECORE_COCOA_CURSOR_RESIZE_LEFT_RIGHT, ECORE_COCOA_CURSOR_RESIZE_RIGHT, ECORE_COCOA_CURSOR_RESIZE_UP, ECORE_COCOA_CURSOR_RESIZE_UP_DOWN, ECORE_COCOA_CURSOR_IBEAM_VERTICAL, __ECORE_COCOA_CURSOR_LAST }
Values of the Cocoa cursors handled by Ecore_Cocoa See https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSCursor_Class/index.html for images of each cursors.

  Functions
EAPI int ecore_cocoa_init (void)
Inits the Ecore_Cocoa library.
EAPI int ecore_cocoa_shutdown (void)
Shuts the Ecore_Cocoa library down.
EAPI void ecore_cocoa_screen_size_get (Ecore_Cocoa_Screen *screen, int *w, int *h)
Retrieves the size of a Cocoa screen.
EAPI Ecore_Cocoa_Window * ecore_cocoa_window_new (int x, int y, int w, int h)
Creates a Cocoa window.
EAPI void ecore_cocoa_window_free (Ecore_Cocoa_Window *window)
Releases a Cocoa window.
EAPI void ecore_cocoa_window_move (Ecore_Cocoa_Window *window, int x, int y)
Moves a Cocoa window at a given point.
EAPI void ecore_cocoa_window_resize (Ecore_Cocoa_Window *window, int w, int h)
Resizes a Cocoa window to a given size.
EAPI void ecore_cocoa_window_move_resize (Ecore_Cocoa_Window *window, int x, int y, int w, int h)
Moves and resizes a Cocoa window to a given point and size.
EAPI void ecore_cocoa_window_geometry_get (const Ecore_Cocoa_Window *window, int *x, int *y, int *w, int *h)
Gets the geometry of a Cocoa window.
EAPI void ecore_cocoa_window_size_get (const Ecore_Cocoa_Window *window, int *w, int *h)
Gets the size of a Cocoa window.
EAPI void ecore_cocoa_window_size_min_set (Ecore_Cocoa_Window *window, int w, int h)
Sets the minimum size of a Cocoa window.
EAPI void ecore_cocoa_window_size_min_get (const Ecore_Cocoa_Window *window, int *w, int *h)
Gets the minimum size size of a Cocoa window.
EAPI void ecore_cocoa_window_size_max_set (Ecore_Cocoa_Window *window, int w, int h)
Sets the maximum size of a Cocoa window.
EAPI void ecore_cocoa_window_size_max_get (const Ecore_Cocoa_Window *window, int *w, int *h)
Gets the maximum size size of a Cocoa window.
EAPI void ecore_cocoa_window_size_step_set (Ecore_Cocoa_Window *window, int w, int h)
Sets a Cocoa window's resize increment.
EAPI void ecore_cocoa_window_size_step_get (const Ecore_Cocoa_Window *window, int *w, int *h)
Gets a Cocoa window's resize increment.
EAPI void ecore_cocoa_window_show (Ecore_Cocoa_Window *window)
Displays a Cocoa window.
EAPI void ecore_cocoa_window_hide (Ecore_Cocoa_Window *window)
Hides a Cocoa window.
EAPI void ecore_cocoa_window_raise (Ecore_Cocoa_Window *window)
Brings a Cocoa window to front.
EAPI void ecore_cocoa_window_lower (Ecore_Cocoa_Window *window)
Brings a Cocoa window back.
EAPI void ecore_cocoa_window_activate (Ecore_Cocoa_Window *window)
Makes a Cocoa window the current key window by raising it.
EAPI void ecore_cocoa_window_title_set (Ecore_Cocoa_Window *window, const char *title)
Changes the title of a Cocoa window.
EAPI void ecore_cocoa_window_iconified_set (Ecore_Cocoa_Window *window, Eina_Bool on)
Miniaturizes or deminiaturizes a Cocoa window.
EAPI void ecore_cocoa_window_borderless_set (Ecore_Cocoa_Window *window, Eina_Bool on)
Manages the borders of a Cocoa window.
EAPI void ecore_cocoa_window_view_set (Ecore_Cocoa_Window *window, Ecore_Cocoa_Object *view)
Sets the content view of a Cocoa window.
EAPI int ecore_cocoa_titlebar_height_get (void)
Gets the height of the title bar of Cocoa windows.
EAPI Ecore_Cocoa_Object * ecore_cocoa_window_get (const Ecore_Cocoa_Window *window)
Retrieves the actual NSWindow behind the Ecore_Cocoa wrapper.
EAPI void ecore_cocoa_window_cursor_set (Ecore_Cocoa_Window *win, Ecore_Cocoa_Cursor c)
Sets the Cocoa cursor for a given Cocoa window.
EAPI void ecore_cocoa_window_cursor_show (Ecore_Cocoa_Window *win, Eina_Bool show)
Hides or shows the Cocoa cursor for a given Cocoa window.
EAPI void ecore_cocoa_terminate_cb_set (Ecore_Cocoa_Terminate_Cb cb)
Overrides the default behaviour in response to an application delete request.
EAPI Eina_Bool ecore_cocoa_clipboard_set (const void *data, int size, const char *mime_type)
EAPI void * ecore_cocoa_clipboard_get (int *size, const char *mime_type)
EAPI void ecore_cocoa_clipboard_clear (void)
EAPI Eina_Bool ecore_cocoa_clipboard_exists (void)

  Variables
EAPI int ECORE_COCOA_EVENT_WINDOW_FOCUSED
Event triggered when a Cocoa window receives focus.
EAPI int ECORE_COCOA_EVENT_WINDOW_UNFOCUSED
Event triggered when a Cocoa window loses focus.
EAPI int ECORE_COCOA_EVENT_WINDOW_RESIZE_REQUEST
Event triggered when a Cocoa window is resized.
EAPI int ECORE_COCOA_EVENT_WINDOW_DESTROY
Event triggered when a Cocoa window get destroyed.

Detailed Description

Ecore_Cocoa Wrapper Library to interact with the Cocoa environment (Mac OS X) from the E environment.

Macro Definition Documentation

  #define ECORE_COCOA_CURSOR_DEFAULT ECORE_COCOA_CURSOR_ARROW

Defines the default Cocoa cursor, to be used when nothing is specified or as a fallback.

Since
    1.18

Typedef Documentation

  Ecore_Cocoa_Window

Opaque handler to manipulate a Cocoa Window through Ecore.

Since
    1.18

  Ecore_Cocoa_Screen

Opaque handler to manipulate a Cocoa Screen through Ecore.

Since
    1.18

  Ecore_Cocoa_Object

Opaque handler to refer to an objective-c object (a.k.a. id)

Since
    1.18

  Ecore_Cocoa_Event_Window_Resize_Request

Type of event thrown when a Cocoa window is resized.

Since
    1.18

  Ecore_Cocoa_Event_Window_Focused

Type of event thrown when a Cocoa window receives focus.

Since
    1.18

  Ecore_Cocoa_Event_Window_Unfocused

Type of event thrown when a Cocoa window loses the focus.

Since
    1.18

  Ecore_Cocoa_Event_Window_Destroy

Type of event thrown when a Cocoa window gets destoyed.

Since
    1.18

  Ecore_Cocoa_Terminate_Cb

Callback called when a delete request is sent to the application. Such function must return EINA_TRUE for the application to terminate, and EINA_FALSE to ignore application termination. It is typically called by a CMD+Q signal.

Parameters
    sender The NSApplication instance to be terminated

Since
    1.19

Enumeration Type Documentation

  enum Ecore_Cocoa_Cursor

Values of the Cocoa cursors handled by Ecore_Cocoa See https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSCursor_Class/index.html for images of each cursors.

Since
    1.18

Enumerator

ECORE_COCOA_CURSOR_ARROW
    Arrow cursor.

ECORE_COCOA_CURSOR_CONTEXTUAL_MENU
    Contextual menu cursor.

ECORE_COCOA_CURSOR_CLOSED_HAND
    Closed hand cursor.

ECORE_COCOA_CURSOR_CROSSHAIR
    Crosshair cursor.

ECORE_COCOA_CURSOR_DISAPPEARING_ITEM
    Disappearing item cursor.

ECORE_COCOA_CURSOR_DRAG_LINK
    Drag copy cursor. Drag link cursor

ECORE_COCOA_CURSOR_IBEAM
    IBeam cursor.

ECORE_COCOA_CURSOR_OPEN_HAND
    Open hand cursor.

ECORE_COCOA_CURSOR_OPERATION_NOT_ALLOWED
    Operation not allowed cursor.

ECORE_COCOA_CURSOR_POINTING_HAND
    Pointing hand cursor.

ECORE_COCOA_CURSOR_RESIZE_DOWN
    Resize down cursor.

ECORE_COCOA_CURSOR_RESIZE_LEFT
    Resize left cursor.

ECORE_COCOA_CURSOR_RESIZE_LEFT_RIGHT
    Resize left right cursor.

ECORE_COCOA_CURSOR_RESIZE_RIGHT
    Resize right cursor.

ECORE_COCOA_CURSOR_RESIZE_UP
    Resize up cursor.

ECORE_COCOA_CURSOR_RESIZE_UP_DOWN
    Resize up down cursor.

ECORE_COCOA_CURSOR_IBEAM_VERTICAL
    IBeam vertical cursor.

__ECORE_COCOA_CURSOR_LAST
    Sentinel. DO NOT USE

Function Documentation

  EAPI int ecore_cocoa_init (void)

Inits the Ecore_Cocoa library.

Returns
    How many times Ecore_Cocoa has been initted

Since
    1.18

  EAPI int ecore_cocoa_shutdown (void)

Shuts the Ecore_Cocoa library down.

Returns
    How many times Ecore_Cocoa has been shut down

Since
    1.18

  EAPI void ecore_cocoa_screen_size_get (Ecore_Cocoa_Screen * screen, int * w, int * h)

Retrieves the size of a Cocoa screen.

Parameters
    screen The screen which size must be retrieved
    w The width of the screen
    h The height of the screen

Since
    1.18

  EAPI Ecore_Cocoa_Window* ecore_cocoa_window_new (int x, int y, int w, int h)

Creates a Cocoa window.

Parameters
    x The origin (X) where the window must be created
    y The origin (Y) where the window must be created
    w The width of the window
    h The height of the window

Returns
    A handler on the window. NULL on failure

Since
    1.18

  EAPI void ecore_cocoa_window_free (Ecore_Cocoa_Window * window)

Releases a Cocoa window.

Parameters
    window The window to be released

Since
    1.18

  EAPI void ecore_cocoa_window_move (Ecore_Cocoa_Window * window, int x, int y)

Moves a Cocoa window at a given point.

Parameters
    window The window to be moved
    x The new origin of the window (X)
    y The new origin of the window (Y)

Since
    1.18

  EAPI void ecore_cocoa_window_resize (Ecore_Cocoa_Window * window, int w, int h)

Resizes a Cocoa window to a given size.

Parameters
    window The window to be moved
    w The new width of the window
    h The new height of the window

Since
    1.18

  EAPI void ecore_cocoa_window_move_resize (Ecore_Cocoa_Window * window, int x, int y, int w, int h)

Moves and resizes a Cocoa window to a given point and size.

Parameters
    window The window to be moved
    x The new origin of the window (X)
    y The new origin of the window (Y)
    w The new width of the window
    h The new height of the window

See also
    ecore_cocoa_window_resize()

    ecore_cocoa_window_move()

Since
    1.18

  EAPI void ecore_cocoa_window_geometry_get (const Ecore_Cocoa_Window * window, int * x, int * y, int * w, int * h)

Gets the geometry of a Cocoa window.

Parameters
    window The window which geometry is queried
    x Pointer used to retrieve its origin in X
    y Pointer used to retrieve its origin in Y
    w Pointer used to retrieve its width
    h Pointer used to retrieve its height

Since
    1.18

  EAPI void ecore_cocoa_window_size_get (const Ecore_Cocoa_Window * window, int * w, int * h)

Gets the size of a Cocoa window.

Parameters
    window The window which size is queried
    w Pointer used to retrieve its width
    h Pointer used to retrieve its height

Since
    1.18

  EAPI void ecore_cocoa_window_size_min_set (Ecore_Cocoa_Window * window, int w, int h)

Sets the minimum size of a Cocoa window.

Parameters
    window The window which minimum size is to be altered
    w The new minimum width of the window
    h The new minimum height of the window

Since
    1.18

  EAPI void ecore_cocoa_window_size_min_get (const Ecore_Cocoa_Window * window, int * w, int * h)

Gets the minimum size size of a Cocoa window.

Parameters
    window The window which minimum size is queried
    w Pointer used to retrieve its minimum width
    h Pointer used to retrieve its minimum height

Since
    1.18

  EAPI void ecore_cocoa_window_size_max_set (Ecore_Cocoa_Window * window, int w, int h)

Sets the maximum size of a Cocoa window.

Parameters
    window The window which maximum size is to be altered
    w The new maximum width of the window
    h The new maximum height of the window

Since
    1.18

  EAPI void ecore_cocoa_window_size_max_get (const Ecore_Cocoa_Window * window, int * w, int * h)

Gets the maximum size size of a Cocoa window.

Parameters
    window The window which maximum size is queried
    w Pointer used to retrieve its maximum width
    h Pointer used to retrieve its maximum height

Since
    1.18

  EAPI void ecore_cocoa_window_size_step_set (Ecore_Cocoa_Window * window, int w, int h)

Sets a Cocoa window's resize increment.

Parameters
    window The Cocoa window which resize increment is to be set
    w The width size increment
    h The height size increment

Since
    1.18

  EAPI void ecore_cocoa_window_size_step_get (const Ecore_Cocoa_Window * window, int * w, int * h)

Gets a Cocoa window's resize increment.

Parameters
    window The Cocoa window which resize increment queried
    w The width size increment
    h The height size increment

Since
    1.18

  EAPI void ecore_cocoa_window_show (Ecore_Cocoa_Window * window)

Displays a Cocoa window.

Parameters
    window The Cocoa window to be displayed

Since
    1.18

  EAPI void ecore_cocoa_window_hide (Ecore_Cocoa_Window * window)

Hides a Cocoa window.

Parameters
    window The Cocoa window to be hid

Since
    1.18

  EAPI void ecore_cocoa_window_raise (Ecore_Cocoa_Window * window)

Brings a Cocoa window to front.

Parameters
    window The Cocoa window to be raised

Since
    1.18

  EAPI void ecore_cocoa_window_lower (Ecore_Cocoa_Window * window)

Brings a Cocoa window back.

Parameters
    window The Cocoa window to be lowered

Since
    1.18

  EAPI void ecore_cocoa_window_activate (Ecore_Cocoa_Window * window)

Makes a Cocoa window the current key window by raising it.

Parameters
    window The Cocoa window to be activated

Since
    1.18

  EAPI void ecore_cocoa_window_title_set (Ecore_Cocoa_Window * window, const char * title)

Changes the title of a Cocoa window.

Parameters
    window The Cocoa window which title is to be changed
    title The new title of the Cocoa window

Since
    1.18

  EAPI void ecore_cocoa_window_iconified_set (Ecore_Cocoa_Window * window, Eina_Bool on)

Miniaturizes or deminiaturizes a Cocoa window.

Parameters
    window The Cocoa window which iconify status is to be changed
    on If EINA_TRUE, will miniaturize the window. Will deminiaturize it if EINA_FALSE

Since
    1.18

  EAPI void ecore_cocoa_window_borderless_set (Ecore_Cocoa_Window * window, Eina_Bool on)

Manages the borders of a Cocoa window.

Parameters
    window The Cocoa window which borders are to be changed
    on If EINA_TRUE, will remove borders. Will restore them if EINA_FALSE

Since
    1.18

  EAPI void ecore_cocoa_window_view_set (Ecore_Cocoa_Window * window, Ecore_Cocoa_Object * view)

Sets the content view of a Cocoa window. Refer to Apple's documentation of the property 'contentView' of the NSWindow class for more details about the content view.

Parameters
    window The Cocoa window which internal view is to be set
    view The NSView to be set as window content view

Since
    1.18

  EAPI int ecore_cocoa_titlebar_height_get (void)

Gets the height of the title bar of Cocoa windows.

Returns
    The height of the title bar of Cocoa windows

Since
    1.18

  EAPI Ecore_Cocoa_Object* ecore_cocoa_window_get (const Ecore_Cocoa_Window * window)

Retrieves the actual NSWindow behind the Ecore_Cocoa wrapper.

Parameters
    window The Ecore_Cocoa wrapper which window is to be retrieved

Returns
    The Cocoa NSWindow manipulated by window

Since
    1.18

  EAPI void ecore_cocoa_window_cursor_set (Ecore_Cocoa_Window * win, Ecore_Cocoa_Cursor c)

Sets the Cocoa cursor for a given Cocoa window.

Parameters
    win The Cocoa window on which the cursor is to be changed.
    c The cursor to be set

Since
    1.18

  EAPI void ecore_cocoa_window_cursor_show (Ecore_Cocoa_Window * win, Eina_Bool show)

Hides or shows the Cocoa cursor for a given Cocoa window.

Parameters
    win The Cocoa window on which the cursor is to be hid
    show Shows the cursor if EINA_TRUE. Hides it if EINA_FALSE

Since
    1.18

  EAPI void ecore_cocoa_terminate_cb_set (Ecore_Cocoa_Terminate_Cb cb)

Overrides the default behaviour in response to an application delete request. When an application receives a delete request (i.e. CMD+Q) the termination callback will be called and its result will determine whether the application should terminate or not

Parameters
    cb The custom termination callback to set

See also
    Ecore_Cocoa_Terminate_Cb

Since
    1.19

Variable Documentation

  EAPI int ECORE_COCOA_EVENT_WINDOW_FOCUSED [extern]

Event triggered when a Cocoa window receives focus.

Since
    1.18

  EAPI int ECORE_COCOA_EVENT_WINDOW_UNFOCUSED [extern]

Event triggered when a Cocoa window loses focus.

Since
    1.18

  EAPI int ECORE_COCOA_EVENT_WINDOW_RESIZE_REQUEST [extern]

Event triggered when a Cocoa window is resized.

Since
    1.18

  EAPI int ECORE_COCOA_EVENT_WINDOW_DESTROY [extern]

Event triggered when a Cocoa window get destroyed.

Since
    1.18

Author

Generated automatically by Doxygen for EFL from the source code.