Class: Wnck::Workspace

Inherits:

Object

• Object
• Wnck::Workspace

Defined in:

(unknown)

Instance Method Summary

• #activate(timestamp) ⇒ nil

  Asks the window manager to make space the active workspace.

• #change_name(name) ⇒ nil

  Changes the name of space.

• #get_neighbor(direction) ⇒ Wnck::Workspace

  Gets the neighbor Wnck::Workspace of space in the direction direction.

• #height ⇒ Integer

  Gets the height of space.

• #is_virtual ⇒ Boolean

  Gets whether space contains a viewport.

• #layout_column ⇒ Integer

  Gets the column of space in the Wnck::Workspace layout.

• #layout_row ⇒ Integer

  Gets the row of space in the Wnck::Workspace layout.

• #name ⇒ String

  Gets the human-readable name that should be used to refer to space.

• #number ⇒ Integer

  Gets the index of space on the Wnck::Screen to which it belongs.

• #screen ⇒ Wnck::Screen

  Gets the Wnck::Screen space is on.

• #viewport_x ⇒ Integer

  Gets the X coordinate of the viewport in space.

• #viewport_y ⇒ Integer

  Gets the Y coordinate of the viewport in space.

• #width ⇒ Integer

  Gets the width of space.

Instance Method Details

#activate(timestamp) ⇒ nil

Asks the window manager to make space the active workspace. The window manager may decide to refuse the request (to not steal the focus if there is a more recent user activity, for example).

This function existed before 2.10, but the timestamp argument was missing in earlier versions. this call to occur.

Parameters:

• timestamp (Integer) —

  the X server timestamp of the user interaction event that caused

Returns:

• (nil)

#change_name(name) ⇒ nil

Changes the name of space.

Parameters:

• name (String) —

  new name for space.

Returns:

• (nil)

#get_neighbor(direction) ⇒ Wnck::Workspace

Gets the neighbor Wnck::Workspace of space in the direction direction. direction direction, or nil if no such neighbor Wnck::Workspace exists. The returned Wnck::Workspace is owned by libwnck and must not be referenced or unreferenced.

Parameters:

• direction (Wnck::MotionDirection) —

  direction in which to search the neighbor.

Returns:

• (Wnck::Workspace) —

  the neighbor Wnck::Workspace of space in the

#height ⇒ Integer

Gets the height of space.

Returns:

• (Integer) —

  the height of space.

#is_virtual ⇒ Boolean

Gets whether space contains a viewport.

Returns:

• (Boolean) —

  true if space contains a viewport, false otherwise.

#layout_column ⇒ Integer

Gets the column of space in the Wnck::Workspace layout. The first column has an index of 0 and is always the left column, regardless of the starting corner set for the layout and regardless of the default direction of the environment (i.e., in both Left-To-Right and Right-To-Left environments). errors.

Returns:

• (Integer) —

  the column of space in the Wnck::Workspace layout, or -1 on

#layout_row ⇒ Integer

Gets the row of space in the Wnck::Workspace layout. The first row has an index of 0 and is always the top row, regardless of the starting corner set for the layout. errors.

Returns:

• (Integer) —

  the row of space in the Wnck::Workspace layout, or -1 on

#name ⇒ String

Gets the human-readable name that should be used to refer to space. If the user has not set a special name, a fallback like "Workspace 3" will be used.

Returns:

• (String) —

  the name of space.

#number ⇒ Integer

Gets the index of space on the Wnck::Screen to which it belongs. The first workspace has an index of 0.

Returns:

• (Integer) —

  the index of space on its Wnck::Screen, or -1 on errors.

#screen ⇒ Wnck::Screen

Gets the Wnck::Screen space is on. Wnck::Screen is owned by libwnck and must not be referenced or unreferenced.

Returns:

• (Wnck::Screen) —

  the Wnck::Screen space is on. The returned

#viewport_x ⇒ Integer

Gets the X coordinate of the viewport in space. contain a viewport.

Returns:

• (Integer) —

  the X coordinate of the viewport in space, or 0 if space does not

#viewport_y ⇒ Integer

Gets the Y coordinate of the viewport in space. contain a viewport.

Returns:

• (Integer) —

  the Y coordinate of the viewport in space, or 0 if space does not

#width ⇒ Integer

Gets the width of space.

Returns:

• (Integer) —

  the width of space.