Display

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool allow_resize { get; set construct; }
• public Connection connection { get; }
• public DisplayDepthColor depth { get; set construct; }
• public bool force_size { get; set construct; }
• public bool grab_keyboard { get; set construct; }
• public GrabSequence grab_keys { get; set construct; }
• public bool grab_pointer { get; set construct; }
• public int height { get; }
• public bool keep_aspect_ratio { get; set construct; }
• public bool local_pointer { get; set construct; }
• public bool lossy_encoding { get; set construct; }
• public string name { get; }
• public bool read_only { get; set construct; }
• public uint rotation { get; set construct; }
• public bool scaling { get; set construct; }
• public bool shared_flag { get; set construct; }
• public bool smoothing { get; set construct; }
• public int width { get; }
• public uint zoom_level { get; set construct; }

Static methods:

• public static unowned OptionEntry[] get_option_entries ()
  Get the array of command line option entries containing VNC specific otions
• public static OptionGroup get_option_group ()
  Get a command line option group containing VNC specific options.

Creation methods:

• public Display ()
  Create a new widget capable of connecting to a VNC server and displaying its contents

Methods:

• public void client_cut_text (string text)
• public void close ()
  Request that the connection to the remote display is closed.
• public void force_grab (bool enable)
  If enable is TRUE, immediately grab the pointer.
• public bool get_allow_resize ()
  Determine whether widget size is used to request rsize of the remote desktop
• public unowned Connection get_connection ()
  Get the VNC connection object associated with the display
• public DisplayDepthColor get_depth ()
  Get the desired colour depth
• public bool get_force_size ()
  Determine whether the widget size is being forced to match the desktop size
• public unowned GrabSequence get_grab_keys ()
  Get the current grab key sequence
• public int get_height ()
  Get the height of the remote desktop.
• public bool get_keep_aspect_ratio ()
  Determine whether the framebuffer aspect ratio is preserved when scaling.
• public bool get_keyboard_grab ()
  Determine if the keyboard will be grabbed when the widget has input focus.
• public bool get_lossy_encoding ()
  Determine whether lossy framebuffer update encodings are permitted
• public Pixbuf get_pixbuf ()
  Take a screenshot of the display.
• public bool get_pointer_grab ()
  Determine if the mouse pointer will be grabbed on first click
• public bool get_pointer_local ()
  Determine if a local pointer will be shown
• public bool get_read_only ()
  Determine if the widget will operate in read-only mode, denying keyboard/mouse inputs
• public uint get_rotation ()
  Determine the current rotation angle of the remote desktop.
• public bool get_scaling ()
  Determine whether the widget is permitted to scale the remote desktop to fit the current widget size.
• public bool get_shared_flag ()
  Determine if other clients are permitted to share the VNC connection
• public bool get_smoothing ()
  Determine whether pixels are smoothly interpolated when scaling.
• public int get_width ()
  Get the width of the remote desktop.
• public uint get_zoom_level ()
  Determine the current constant scaling factor.
• public bool is_open ()
  Check if the connection for the display is currently open
• public bool is_pointer_absolute ()
  Determine if the pointer is operating in absolute mode.
• public bool open_addr (SocketAddress addr, string? hostname)
  Open a socket connection to server identified by addr.
• public bool open_fd (int fd)
  Open a connection using fd as the transport.
• public bool open_fd_with_hostname (int fd, string? hostname)
  Open a connection using fd as the transport.
• public bool open_host (string host, string port)
  Open a TCP connection to the remote desktop at host listening on port.
• public bool request_update ()
• public void send_keys (uint[] keyvals)
  Send keyval click events to the display.
• public void send_keys_ex (uint[] keyvals, DisplayKeyEvent kind)
  Sends key events to the remote server.
• public void send_pointer (int x, int y, int button_mask)
  Move the remote pointer to position (x, y) and set the button state to button_mask.
• public void set_allow_resize (bool enable)
  Set whether changes in the widget size will be translated into requests to resize the remote desktop.
• public bool set_credential (int type, string data)
  Sets the value of the authentication credential type to the string data.
• public void set_depth (DisplayDepthColor depth)
  Set the desired colour depth.
• public void set_force_size (bool enable)
  Set whether the widget size will be forced to match the remote desktop size.
• public void set_grab_keys (GrabSequence seq)
  Set the sequence of keys that must be pressed to activate keyborad and pointer grab
• public void set_keep_aspect_ratio (bool enable)
  Set whether the aspect ratio of the framebuffer is preserved when scaling.
• public void set_keyboard_grab (bool enable)
  Set whether the widget will grab the keyboard when it has focus.
• public void set_lossy_encoding (bool enable)
  Set whether the client is willing to accept lossy framebuffer update encodings.
• public void set_pointer_grab (bool enable)
  Set whether the widget will automatically grab the mouse pointer upon a button click
• public void set_pointer_local (bool enable)
  If enable is TRUE, then a local mouse cursor will be made visible.
• public void set_read_only (bool enable)
  Set whether the widget is running in read-only mode.
• public void set_rotation (uint rotation)
  Set the rotation angle to view the display of the remote desktop, in clockwise direction.
• public bool set_scaling (bool enable)
  Set whether the remote desktop contents is automatically scaled to fit the available widget size, or whether it will be rendered at 1:1 size
• public void set_shared_flag (bool shared)
  Set the shared state for the connection.
• public void set_smoothing (bool enable)
  Set whether pixels are smoothly interpolated when scaling, to avoid aliasing.
• public void set_zoom_level (uint zoom)
  Requests a constant scaling factor to be applied to the remote desktop.

Signals:

• public virtual signal void vnc_auth_credential (ValueArray credList)
• public signal void vnc_auth_failure (string object)
• public signal void vnc_auth_unsupported (uint object)
• public signal void vnc_bell ()
• public virtual signal void vnc_connected ()
• public signal void vnc_desktop_rename (string object)
• public signal void vnc_desktop_resize (int object, int p0)
• public virtual signal void vnc_disconnected ()
• public signal void vnc_error (string object)
• public virtual signal void vnc_initialized ()
• public signal void vnc_keyboard_grab ()
• public signal void vnc_keyboard_ungrab ()
• public signal void vnc_pointer_grab ()
• public signal void vnc_pointer_ungrab ()
• public signal void vnc_power_control_failed ()
• public signal void vnc_power_control_initialized ()
• public signal void vnc_server_cut_text (string object)

Inherited Members: