/* FIXME: Shouldn't be here. */ type Ecore_Evas: __undefined_type; type Ecore_Window: __undefined_type; enum Elm.Win.Type { [[Defines the types of window that can be created These are hints set on the window so that a running Window Manager knows how the window should be handled and/or what kind of decorations it should have. Currently, only the X11 backed engines use them. ]] legacy: elm_win; unknown = -1, basic, [[A normal window. Indicates a normal, top-level window. Almost every window will be created with this type.]] dialog_basic, [[Used for simple dialog windows.]] desktop, [[For special desktop windows, like a background window holding desktop icons.]] dock, [[The window is used as a dock or panel. Usually would be kept on top of any other window by the Window Manager.]] toolbar, [[The window is used to hold a floating toolbar, or similar.]] menu, [[Similar to #ELM_WIN_TOOLBAR.]] utility, [[A persistent utility window, like a toolbox or palette.]] splash, [[Splash window for a starting up application.]] dropdown_menu, [[The window is a dropdown menu, as when an entry in a menubar is clicked. This hint exists for completion only, as the EFL way of implementing a menu would not normally use a separate window for its contents.]] popup_menu, [[Like #ELM_WIN_DROPDOWN_MENU, but for the menu triggered by right-clicking an object.]] tooltip, [[The window is a tooltip. A short piece of explanatory text that typically appear after the mouse cursor hovers over an object for a while. Typically not very commonly used in the EFL.]] notification, [[A notification window, like a warning about battery life or a new E-Mail received.]] combo, [[A window holding the contents of a combo box. Not usually used in the EFL.]] dnd, [[Used to indicate the window is a representation of an object being dragged across different windows, or even applications. Typically used with elm_win_override_set().]] inlined_image, [[The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer. This allows to have children window inside a parent one just like any other object would be, and do other things like applying \@ref Evas_Map effects to it. This is the only type of window that requires the parent parameter of \@ref elm_win_add to be a valid @Evas.Object.]] socket_image, [[The window is rendered onto an image buffer and can be shown other process's plug image object. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer and can be shown other process's plug image object. ]] fake [[This window was created using a pre-existing canvas. The window widget can be deleted, but the canvas must be managed externally. @since 1.13 ]] } enum Elm.Win.Keyboard_Mode { [[The different layouts that can be requested for the virtual keyboard. When the application window is being managed by Illume, it may request any of the following layouts for the virtual keyboard. ]] legacy: elm_win_keyboard; unknown, [[Unknown keyboard state]] off, [[Request to deactivate the keyboard]] on, [[Enable keyboard with default layout]] alpha, [[Alpha (a-z) keyboard layout]] numeric, [[Numeric keyboard layout]] pin, [[PIN keyboard layout]] phone_number, [[Phone keyboard layout]] hex, [[Hexadecimal numeric keyboard layout]] terminal, [[Full (QWERTY) keyboard layout]] password, [[Password keyboard layout]] ip, [[IP keyboard layout]] host, [[Host keyboard layout]] file, [[File keyboard layout]] url, [[URL keyboard layout]] keypad, [[Keypad layout]] j2me [[J2ME keyboard layout]] } enum Elm.Win.Indicator_Type { [[Defines the type indicator that can be shown]] legacy: elm_win_indicator; type_unknown, [[Unknown indicator type]] bg_opaque, [[The icon of indicator is opaque, the background of indicator is also opaque. The content of window is located the end of indicator. The area of indicator and window content are not overlapped]] bg_transparent, [[The icon of indicator is opaque, but the background is transparent. The content of window is located under the indicator in Z-order. The area of indicator and window content are overlapped]] hidden [[The indicator is hidden, So user can see only the content of window like the video mode. If user flicks the upper side of window, the incator is shown temporarily.]] } /** */ enum Elm.Win.Keygrab_Mode { [[Define the keygrab modes of window. A window may send commands to the Keyrouter according this mode, and perform different actions.]] legacy: elm_win_keygrab; unknown = 0, [[Unknown keygrab mode]] shared = (1 << 8), [[Getting the grabbed-key together with the other client windows]] topmost = (1 << 9), [[Getting the grabbed-key only when window is top of the stack]] exclusive = (1 << 10), [[Getting the grabbed-key exclusively regardless of window's position]] override_exclusive = (1 << 11) [[Getting the grabbed-key exclusively regardless of window's position. Being overrided the grab by the other client window]] } enum Elm.Win.Modal_Mode { [[Defines the mode of a modal window]] none, [[The window is not modal window.]] modal [[The window is modal window.]] } enum Elm.Win.Urgent_Mode { [[Defines the mode of a urgent window.]] none, [[The window is not a urgent window.]] urgent [[The window is a urgent window.]] } class Elm.Win (Elm.Widget, Elm.Interface.Atspi.Window, Elm.Interface.Atspi_Widget_Action, Efl.Pack, Efl.Input.State, Efl.Input.Interface, Efl.Screen, Efl.Gfx.Size.Hint, Efl.Text) { legacy_prefix: elm_win; eo_prefix: elm_obj_win; event_prefix: elm_win; methods { @property indicator_enabled { set { [[In some environments, like phones, you may have an indicator that shows battery status, reception, time etc. This is the indicator. Sometimes you don't want it because you provide the same functionality inside your app, so this will request that the indicator is disabled in this circumstance. The default is depend on the environments. For example, like phones, default is to enable the indicator. But like TV, default is to disable the indicator. Sets the indicator enable of the window.]] } get { [[Get the indicator enable of the window.]] } values { enabled: bool; [[If true, the indicator is enabled, If false, the indicator is disabled.]] } } @property indicator_type { set { [[Sets the indicator type of the window.]] } get { [[Get the indicator type of the window.]] } values { type: Elm.Win.Indicator_Type; [[The type, one of #Elm_Win_Indicator_Type.]] } } @property keyboard_mode { set { [[Sets the keyboard mode of the window.]] } get { [[Get the keyboard mode of the window.]] } values { mode: Elm.Win.Keyboard_Mode; [[The mode, one of #Elm_Win_Keyboard_Mode.]] } } @property wm_available_rotations { set { [[Set the array of available window rotations. This function is used to set the available rotations to give the hints to WM. WM will refer this hints and set the orientation window properly. @since 1.9 ]] legacy: elm_win_wm_rotation_available_rotations_set; values { rotations: const(int)*; [[The array of rotation value.]] count: uint; [[The size of the rotations array.]] } } get { [[Get the array of available window rotations. This function is used to get the available rotations. @since 1.9 ]] legacy: elm_win_wm_rotation_available_rotations_get; values { rotations: int*; [[The array of rotation value.]] count: uint; [[The size of the rotations array.]] } return: bool; } } @property screen_constrain { set { [[Constrain the maximum width and height of a window to the width and height of its screen. When $constrain is $true, $obj will never resize larger than the screen. ]] } get { [[Get the constraints on the maximum width and height of a window relative to the width and height of its screen. When this function returns $true, $obj will never resize larger than the screen. ]] } values { constrain: bool; [[$true to restrict the window's maximum size.]] } } @property focus_highlight_style { set { [[Set the style for the focus highlight on this window. Sets the style to use for theming the highlight of focused objects on the given window. If $style is NULL, the default will be used. ]] } get { [[Get the style set for the focus highlight object.]] } values { style: string @nullable; [[The style or $null if none.]] } } @property focus_highlight_enabled { set { [[Set the enabled status for the focus highlight in a window. This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it. ]] } get { [[Get the enabled value of the focus highlight for this window.]] } values { enabled: bool; [[The enabled value for the highlight.]] } } @property focus_highlight_animate { set { [[Set the animate status for the focus highlight for this window. This function will enable or disable the animation of focus highlight only for the given window, regardless of the global setting for it. ]] } get { [[Get the animate value of the focus highlight for this window.]] } values { animate: bool; [[The enabled value for the highlight animation.]] } } @property prop_focus_skip { set { [[Set the window to be skipped by keyboard focus. This sets the window to be skipped by normal keyboard input. This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager, "alt-tab" list etc. etc. Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect. Use this for windows that have only output information or might only be interacted with by the mouse or fingers, and never for typing input. Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care. ]] } values { skip: bool; [[The skip flag state ($true if it is to be skipped).]] } } @property focus { get { [[Get whether a window has focus.]] return: bool; } } @property autodel { set { [[Set the window's autodel state. When closing the window in any way outside of the program control, like pressing the X button in the titlebar or using a command from the Window Manager, a "delete,request" signal is emitted to indicate that this event occurred and the developer can take any action, which may include, or not, destroying the window object. When the $autodel parameter is set, the window will be automatically destroyed when this event occurs, after the signal is emitted. If $autodel is $false, then the window will not be destroyed and is up to the program to do so when it's required. ]] } get { [[Get the window's autodel state.]] } values { autodel: bool; [[If true, the window will automatically delete itself when closed.]] } } @property autohide { [[Window's autohide state. This property works similarly to @.autodel, automatically handling "delete,request" signals when set to $trze, with the difference that it will hide the window, instead of destroying it. It is specially designed to work together with $ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN which allows exiting Elementary's main loop when all the windows are hidden. Note: @.autodel and $autohide are not mutually exclusive. The window will be deleted if both are set to $true. ]] set { } get { } values { autohide: bool; [[If true, the window will automatically hide itself when closed.]] } } @property icon_object { set { [[Set a window object's icon. This sets an image to be used as the icon for the given window, in the window manager decoration part. The exact pixel dimensions of the object (not object size) will be used, and the image pixels will be used as-is when this function is called. If the image object has been updated, then call this function again to source the image pixels and put them on the window's icon. Note that only Evas image objects are allowed. ]] /* FIXME-doc Example of usage: @code icon = evas_object_image_add(evas_object_evas_get(elm_window)); evas_object_image_file_set(icon, "/path/to/the/icon", NULL); elm_win_icon_object_set(elm_window, icon); evas_object_show(icon); @endcode */ values { icon: Evas.Object @nullable; [[The Evas image object to use for an icon.]] } } get { [[Get the icon object used for the window. The object returns is the one marked by @.icon_object.set as the object to use for the window icon. ]] values { icon: const(Evas.Object) @nullable; [[The Evas image object to use for an icon.]] } } } @property iconified { set { [[Set the iconified state of a window.]] } get { [[Get the iconified state of a window.]] } values { iconified: bool; [[If true, the window is iconified.]] } } @property maximized { set { [[Set the maximized state of a window.]] } get { [[Get the maximized state of a window.]] } values { maximized: bool; [[If true, the window is maximized.]] } } @property fullscreen { set { [[Set the fullscreen state of a window.]] } get { [[Get the fullscreen state of a window.]] } values { fullscreen: bool; [[If $true, the window is fullscreen.]] } } @property sticky { set { [[Set the sticky state of the window. Hints the Window Manager that the window in $obj should be left fixed at its position even when the virtual desktop it's on moves or changes. ]] } get { [[Get the sticky state of the window.]] } values { sticky: bool; [[If true, the window's sticky state is enabled.]] } } @property urgent { set { [[Set the urgent state of a window.]] legacy: null; } get { [[Get the urgent state of a window.]] legacy: null; } values { urgent: Elm.Win.Urgent_Mode; [[The mode of a urgent window, one of #Elm_Win_Urgent_Mode.]] } } @property modal { set { [[Set the modal state of a window.]] legacy: null; } get { [[Get the modal state of a window.]] legacy: null; } values { modal: Elm.Win.Modal_Mode; [[The mode of a window, one of #Elm_Win_Modal_Mode.]] } } @property noblank { set { [[Set the noblank property of a window. The "noblank" property is a way to request the display on which the windowis shown does not blank, screensave or otherwise hide or obscure the window. It is intended for uses such as media playback on a television where a user may not want to be interrupted by an idle screen. The noblank property may have no effect if the window is iconified/minimized or hidden. @since 1.11 ]] } get { [[Get the noblank property of a window. @since 1.11 ]] } values { noblank: bool; [[If true, the window is set to noblank.]] } } @property borderless { set { [[Set the borderless state of a window. This function requests the Window Manager to not draw any decoration around the window. ]] } get { [[Get the borderless state of a window.]] } values { borderless: bool; [[If true, the window is borderless.]] } } @property role { set { [[Set the role of the window.]] } get { [[Get the role of the window. The returned string is an internal one and should not be freed or modified. It will also be invalid if a new role is set or if the window is destroyed. ]] } values { role: string; [[The role to set.]] } } @property name { [[The window name. The meaning of name depends on the underlying windowing system. The window name is a constructing property that need to be set at creation within \@ref eo_add. Note: Once set, it can NOT be modified afterward. ]] /* FIXME-doc Example: @code win = eo_add(ELM_WIN_CLASS, NULL, elm_obj_win_name_set(ELM_WIN_BASIC)); @endcode */ set { [[Can only be used at creation time, within \@ref eo_add.]] legacy: null; } values { name: string @nullable; } } @property type { [[The type of the window. It is a hint of how the Window Manager should handle it. The window type is a constructing property that need to be set at creation within \@ref eo_add. Note: Once set, it can NOT be modified afterward. ]] /* FIXME-doc Example: @code win = eo_add(ELM_WIN_CLASS, NULL, elm_obj_win_type_set(ELM_WIN_BASIC)); @endcode */ set { [[Can only be used at creation time, within \@ref eo_add.]] legacy: null; } get { [[If the object is not window object, return #ELM_WIN_UNKNOWN.]] } values { type: Elm.Win.Type(Elm.Win.Type.unknown); } } @property available_profiles { set { [[Set the array of available profiles to a window. @since 1.8 ]] values { profiles: string*; [[The string array of available profiles.]] count: uint; [[The number of members in profiles.]] } } get { [[Get the array of available profiles of a window. @since 1.8 ]] values { profiles: char**; [[The string array of available profiles.]] count: uint; [[The number of members in profiles.]] } return: bool; } } @property alpha { set { [[Set the alpha channel state of a window. If $alpha is true, the alpha channel of the canvas will be enabled possibly making parts of the window completely or partially transparent. This is also subject to the underlying system supporting it, like for example, running under a compositing manager. Note: Alpha window can be enabled automatically by window theme style's property. If "alpha" data.item is "1" or "true" in window style(eg. elm/win/base/default), the window is switched to alpha automatically without the explicit api call. ]] } get { [[Get the alpha channel state of a window.]] } values { alpha: bool; [[$true if the window alpha channel is enabled, $false otherwise.]] } } @property aspect { set { [[Set the aspect ratio of a window.]] } get { [[Get the aspect ratio of a window.]] } values { aspect: double; [[If 0, the window has no aspect limits, otherwise it is width divided by height.]] } } socket_listen { [[Create a socket to provide the service for Plug widget.]] return: bool; params { @in svcname: string; [[The name of the service to be advertised. Eensure that it is unique (when combined with $svcnum) otherwise creation may fail.]] @in svcnum: int; [[A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.]] @in svcsys: bool; [[A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.]] } } activate { [[Activate a window object. This function sends a request to the Window Manager to activate the window pointed by $obj. If honored by the WM, the window will receive the keyboard focus. Note: This is just a request that a Window Manager may ignore, so calling this function does not ensure in any way that the window will be the active one after it. ]] } raise { [[Raise a window object. Places the window pointed by $obj at the top of the stack, so that it's not covered by any other window. ]] } center { [[Center a window on its screen This function centers window $obj horizontally and/or vertically based on the values of $h and $v. ]] params { @in h: bool; [[If true, center horizontally. If false, do not change horizontal location.]] @in v: bool; [[If true, center vertically. If false, do not change vertical location.]] } } keygrab_set { [[Set keygrab value of the window This function grabs the $key of window using $grab_mode. ]] return: bool; params { @in key: string; [[This string is the keyname to grab.]] @in modifiers: Evas.Modifier_Mask; [[This is for the keymask feature. Currently this feature is not supported.]] @in not_modifiers: Evas.Modifier_Mask; [[This is for the keymask feature. Currently this feature is not supported.]] @in proirity: int; [[This is for the priority of keygrab. Currently this feature is not supported.]] @in grab_mode: Elm.Win.Keygrab_Mode; [[According to the grabmode, it can grab key differently.]] } } keygrab_unset { [[Unset keygrab value of the window This function unset keygrab value. Ungrab $key of window. ]] return: bool; params { @in key: string; [[This string is the keyname to grab.]] @in modifiers: Evas.Modifier_Mask; [[This is for the keymask feature. Currently this feature is not supported.]] @in not_modifiers: Evas.Modifier_Mask; [[This is for the keymask feature. Currently this feature is not supported.]] } } teamwork_uri_preload { [[Notify the compositor that a uri should be preloaded @since 1.18 ]] params { @in uri: string; [[This is the uri to notify with]] } } teamwork_uri_show { [[Notify the compositor that a uri should be displayed Sends the current mouse coordinates as a hint for displaying the related uri in the compositor. @since 1.18 ]] params { @in uri: string; [[This is the uri to notify with]] } } teamwork_uri_hide { [[Notify the compositor that a uri should be hidden Hides any uri-related media displayed in the compositor through previous \@ref elm_win_teamwork_uri_show request @since 1.18 ]] } teamwork_uri_open { [[Notify the compositor that a uri should be opened Use the compositor's default application to open a uri @since 1.18 ]] params { @in uri: string; [[This is the uri to open]] } } } implements { class.constructor; Eo.Base.constructor; Eo.Base.finalize; Evas.Object.Smart.hide; Evas.Object.Smart.show; Evas.Object.Smart.move; Evas.Object.Smart.add; Evas.Object.Smart.del; Evas.Object.Smart.resize; Elm.Widget.focus_direction; Elm.Widget.focus_next_manager_is; Elm.Widget.focus_direction_manager_is; Elm.Widget.focus_next; Elm.Widget.theme_apply; Elm.Widget.on_focus; Elm.Widget.event; Elm.Interface.Atspi_Accessible.parent.get; Elm.Interface.Atspi_Accessible.state_set.get; Elm.Interface.Atspi_Accessible.name.get; Elm.Interface.Atspi_Widget_Action.elm_actions.get; Efl.Container.content_remove; Efl.Container.content_iterate; Efl.Container.content_count; Efl.Pack.unpack; Efl.Pack.pack; Efl.Input.State.modifier_enabled.get; Efl.Input.State.lock_enabled.get; Efl.Screen.dpi.get; Efl.Screen.rotation.get; Efl.Screen.size.get; Efl.Gfx.Size.Hint.base.set; Efl.Gfx.Size.Hint.base.get; Efl.Gfx.Size.Hint.step.set; Efl.Gfx.Size.Hint.step.get; Efl.Text.text.set; Efl.Text.text.get; } constructors { .name; .type; } events { delete,request; moved; withdrawn; iconified; normal; stick; unstick; fullscreen; unfullscreen; maximized; unmaximized; ioerr; indicator,prop,changed; rotation,changed; profile,changed; wm,rotation,changed; theme,changed; elm,action,block_menu; } }