PlankWidgetsHoverWindow

PlankWidgetsHoverWindow — A hover window that shows labels for dock items. This window floats outside (but near) the dock. The window uses a themed renderer and has its own theme file.

Synopsis

#define             PLANK_WIDGETS_TYPE_HOVER_WINDOW
void                plank_widgets_hover_window_move_hover
                                                        (PlankWidgetsHoverWindow *self,
                                                         gint item_x,
                                                         gint item_y);
PlankWidgetsHoverWindow * plank_widgets_hover_window_new
                                                        (PlankDockController *controller);
const gchar *       plank_widgets_hover_window_get_Text (PlankWidgetsHoverWindow *self);
void                plank_widgets_hover_window_set_Text (PlankWidgetsHoverWindow *self,
                                                         const gchar *value);
struct              PlankWidgetsHoverWindow;
struct              PlankWidgetsHoverWindowClass;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkWindow
                                 +----PlankWidgetsCompositedWindow
                                       +----PlankWidgetsHoverWindow

Implemented Interfaces

PlankWidgetsHoverWindow implements AtkImplementorIface and GtkBuildable.

Properties

  "Text"                     gchar*                : Read / Write
  "controller"               PlankDockController*  : Write / Construct Only

Description

Details

PLANK_WIDGETS_TYPE_HOVER_WINDOW

#define PLANK_WIDGETS_TYPE_HOVER_WINDOW (plank_widgets_hover_window_get_type ())

The type for PlankWidgetsHoverWindow.


plank_widgets_hover_window_move_hover ()

void                plank_widgets_hover_window_move_hover
                                                        (PlankWidgetsHoverWindow *self,
                                                         gint item_x,
                                                         gint item_y);

Centers the window at the x/y location specified.

self :

the PlankWidgetsHoverWindow instance

item_x :

 . the x location. [in]

item_y :

 . the y location. [in]

plank_widgets_hover_window_new ()

PlankWidgetsHoverWindow * plank_widgets_hover_window_new
                                                        (PlankDockController *controller);

controller :

 

plank_widgets_hover_window_get_Text ()

const gchar *       plank_widgets_hover_window_get_Text (PlankWidgetsHoverWindow *self);

Get and return the current value of the "Text" property.

The text to display in the window.

self :

the PlankWidgetsHoverWindow instance to query

Returns :

the value of the "Text" property

plank_widgets_hover_window_set_Text ()

void                plank_widgets_hover_window_set_Text (PlankWidgetsHoverWindow *self,
                                                         const gchar *value);

Set the value of the "Text" property to value.

The text to display in the window.

self :

the PlankWidgetsHoverWindow instance to modify

value :

the new value of the "Text" property

struct PlankWidgetsHoverWindow

struct PlankWidgetsHoverWindow;

A hover window that shows labels for dock items. This window floats outside (but near) the dock. The window uses a themed renderer and has its own theme file.


struct PlankWidgetsHoverWindowClass

struct PlankWidgetsHoverWindowClass {
	PlankWidgetsCompositedWindowClass parent_class;
};

The class structure for PLANK_WIDGETS_TYPE_HOVER_WINDOW. All the fields in this structure are private and should never be accessed directly.

PlankWidgetsCompositedWindowClass parent_class;

the parent class structure

Property Details

The "Text" property

  "Text"                     gchar*                : Read / Write

The text to display in the window.

Default value: NULL


The "controller" property

  "controller"               PlankDockController*  : Write / Construct Only

controller.