GscInfo

GscInfo — Calltips object

Synopsis

                    GscInfoPrivate;
                    GscInfo;
GscInfo *           gsc_completion_info_new             (void);
void                gsc_completion_info_move_to_iter    (GscInfo *info,
                                                         GtkTextView *view,
                                                         GtkTextIter *iter);
void                gsc_completion_info_set_sizing      (GscInfo *info,
                                                         gint width,
                                                         gint height,
                                                         gboolean shrink_width,
                                                         gboolean shrink_height);
void                gsc_completion_info_set_widget      (GscInfo *info,
                                                         GtkWidget *widget);
GtkWidget *         gsc_completion_info_get_widget      (GscInfo *info);
void                gsc_completion_info_process_resize  (GscInfo *info);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GscInfo

Implemented Interfaces

GscInfo implements AtkImplementorIface and GtkBuildable.

Properties

  "max-height"               gint                  : Read / Write / Construct
  "max-width"                gint                  : Read / Write / Construct
  "shrink-height"            gboolean              : Read / Write / Construct
  "shrink-width"             gboolean              : Read / Write / Construct

Signals

  "before-show"                                    : Run Last / Action

Description

This object can be used to show a calltip or help.

Details

GscInfoPrivate

typedef struct _GscInfoPrivate GscInfoPrivate;


GscInfo

typedef struct _GscInfo GscInfo;


gsc_completion_info_new ()

GscInfo *           gsc_completion_info_new             (void);

Returns :

The new GscInfo.

gsc_completion_info_move_to_iter ()

void                gsc_completion_info_move_to_iter    (GscInfo *info,
                                                         GtkTextView *view,
                                                         GtkTextIter *iter);

Moves the GscInfo to iter. If iter is NULL info is moved to the cursor position. Moving will respect the GdkGravity setting of the info window and will ensure the line at iter is not occluded by the window.

info :

A GscInfo

view :

A GtkTextView on which the info window should be positioned

iter :

A GtkTextIter

gsc_completion_info_set_sizing ()

void                gsc_completion_info_set_sizing      (GscInfo *info,
                                                         gint width,
                                                         gint height,
                                                         gboolean shrink_width,
                                                         gboolean shrink_height);

Set sizing information for the info window. If shrink_width or shrink_height is TRUE, the info window will try to resize to fit the window contents, with a maximum size given by width and height. Setting width or height to -1 removes the maximum size of respectively the width and height of the window.

info :

A GscInfo

width :

The maximum/requested width of the window (-1 to default)

height :

The maximum/requested height of the window (-1 to default)

shrink_width :

Whether to shrink the width of the window to fit its contents

shrink_height :

Whether to shrink the height of the window to fit its contents

gsc_completion_info_set_widget ()

void                gsc_completion_info_set_widget      (GscInfo *info,
                                                         GtkWidget *widget);

Sets the content widget of the info window. If widget does not fit within the size requirements of the window, a GtkScrolledWindow will automatically be created and added to the window.

info :

A GscInfo

widget :

A GtkWidget

gsc_completion_info_get_widget ()

GtkWidget *         gsc_completion_info_get_widget      (GscInfo *info);

Get the current content widget.

info :

A GscInfo

Returns :

The current content widget.

gsc_completion_info_process_resize ()

void                gsc_completion_info_process_resize  (GscInfo *info);

info :

Property Details

The "max-height" property

  "max-height"               gint                  : Read / Write / Construct

The maximum allowed height.

Allowed values: >= -1

Default value: -1


The "max-width" property

  "max-width"                gint                  : Read / Write / Construct

The maximum allowed width.

Allowed values: >= -1

Default value: -1


The "shrink-height" property

  "shrink-height"            gboolean              : Read / Write / Construct

Whether the window should shrink height to fit the contents.

Default value: TRUE


The "shrink-width" property

  "shrink-width"             gboolean              : Read / Write / Construct

Whether the window should shrink width to fit the contents.

Default value: TRUE

Signal Details

The "before-show" signal

void                user_function                      (GscInfo *gscinfo,
                                                        gpointer user_data)      : Run Last / Action

gscinfo :

the object which received the signal.

user_data :

user data set when the signal handler was connected.