Class: Wnck::Pager

Inherits:

Gtk::Widget

• Object
• Gtk::Widget
• Wnck::Pager

Defined in:

(unknown)

Instance Method Summary

• #display_mode=(mode) ⇒ nil

  Sets the display mode for pager to mode.

• #handle ⇒ Wnck::Handle

  Handle.

• #handle=(handle) ⇒ Wnck::Handle
• #initialize(handle) ⇒ Gtk::Widget constructor

  Creates a new Wnck::Pager.

• #n_rows=(n_rows) ⇒ Boolean

  Tries to change the number of rows in the layout of Wnck::Workspace on the Wnck::Screen pager is watching.

• #orientation=(orientation) ⇒ Boolean

  Tries to change the orientation of the layout of Wnck::Workspace on the Wnck::Screen pager is watching.

• #scroll_mode=(scroll_mode) ⇒ nil

  Sets pager to react to input device scrolling in one of the available scroll modes.

• #shadow_type=(shadow_type) ⇒ nil

  Sets the shadow type for pager to shadow_type.

• #show_all=(show_all_workspaces) ⇒ nil

  Sets pager to display all Wnck::Workspace or not, according to show_all_workspaces.

• #wrap_on_scroll ⇒ Boolean

  hits a border, false otherwise.

• #wrap_on_scroll=(wrap_on_scroll) ⇒ nil

  Sets the wrapping behavior of the pager.

Constructor Details

#initialize(handle) ⇒ Gtk::Widget

Creates a new Wnck::Pager. The #WnckPager will show the #WnckWorkspace of the Wnck::Screen it is on.

Parameters:

• handle (Wnck::Handle) —

  a Wnck::Handle

Instance Method Details

#display_mode=(mode) ⇒ nil

Sets the display mode for pager to mode.

Parameters:

• mode (Wnck::PagerDisplayMode) —

  a display mode.

Returns:

• (nil)

#handle ⇒ Wnck::Handle

Returns handle.

Returns:

• (Wnck::Handle) —

  handle

#handle=(handle) ⇒ Wnck::Handle

Parameters:

• handle (Wnck::Handle)

Returns:

• (Wnck::Handle) —

  handle

• (Wnck::Handle) —

  handle

#n_rows=(n_rows) ⇒ Boolean

Tries to change the number of rows in the layout of Wnck::Workspace on the Wnck::Screen pager is watching. Since no more than one application should set this property of a Wnck::Screen at a time, setting the layout is not guaranteed to work.

If pager has not been added to a widget hierarchy, the call will fail because pager can't know the screen on which to modify the layout. Wnck::Screen pager is watching. changed or did not need to be changed, false otherwise.

Parameters:

• n_rows (Integer) —

  the number of rows to use for the layout of Wnck::Workspace on the

Returns:

• (Boolean) —

  true if the layout of Wnck::Workspace has been successfully

#orientation=(orientation) ⇒ Boolean

Tries to change the orientation of the layout of Wnck::Workspace on the Wnck::Screen pager is watching. Since no more than one application should set this property of a Wnck::Screen at a time, setting the layout is not guaranteed to work.

If orientation is %GTK_ORIENTATION_HORIZONTAL, the Wnck::Workspace will be laid out in rows, with the first Wnck::Workspace in the top left corner.

If orientation is %GTK_ORIENTATION_VERTICAL, the Wnck::Workspace will be laid out in columns, with the first Wnck::Workspace in the top left corner.

For example, if the layout contains one row, but the orientation of the layout is vertical, the Wnck::Pager will display a column of #WnckWorkspace.

Note that setting the orientation will have an effect on the geometry management: if orientation is %GTK_ORIENTATION_HORIZONTAL, %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT will be used as request mode; if orientation is %GTK_ORIENTATION_VERTICAL, GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH will be used instead.

If pager has not been added to a widget hierarchy, the call will fail because pager can't know the screen on which to modify the orientation. Wnck::Screen pager is watching. changed or did not need to be changed, false otherwise.

Parameters:

• orientation (Gtk::Orientation) —

  orientation to use for the layout of Wnck::Workspace on the

Returns:

• (Boolean) —

  true if the layout of Wnck::Workspace has been successfully

#scroll_mode=(scroll_mode) ⇒ nil

Sets pager to react to input device scrolling in one of the available scroll modes.

Parameters:

• scroll_mode (Wnck::PagerScrollMode) —

  a scroll mode.

Returns:

• (nil)

#shadow_type=(shadow_type) ⇒ nil

Sets the shadow type for pager to shadow_type. The main use of this function is proper integration of Wnck::Pager in panels with non-system backgrounds.

Parameters:

• shadow_type (Gtk::ShadowType) —

  a shadow type.

Returns:

• (nil)

#show_all=(show_all_workspaces) ⇒ nil

Sets pager to display all Wnck::Workspace or not, according to show_all_workspaces.

Parameters:

• show_all_workspaces (Boolean) —

  whether to display all Wnck::Workspace in pager.

Returns:

• (nil)

#wrap_on_scroll ⇒ Boolean

hits a border, false otherwise.

Returns:

• (Boolean) —

  true if the pager wraps workspaces on a scroll event that

#wrap_on_scroll=(wrap_on_scroll) ⇒ nil

Sets the wrapping behavior of the pager. Setting it to true will wrap arround to the start when scrolling over the end and vice versa. By default it is set to false.

Parameters:

• wrap_on_scroll (Boolean) —

  a boolean.

Returns:

• (nil)