CtkToolShell: CTK+ 3 Reference Manual

## CtkToolShell CtkToolShell — Interface for containers containing CtkToolItem widgets |

## Functions

PangoEllipsizeMode | ctk_tool_shell_get_ellipsize_mode ()
CtkIconSize | ctk_tool_shell_get_icon_size ()
CtkOrientation | ctk_tool_shell_get_orientation ()
CtkReliefStyle | ctk_tool_shell_get_relief_style ()
CtkToolbarStyle | ctk_tool_shell_get_style ()
gfloat | ctk_tool_shell_get_text_alignment ()
CtkOrientation | ctk_tool_shell_get_text_orientation ()
void | ctk_tool_shell_rebuild_menu ()
CtkSizeGroup * | ctk_tool_shell_get_text_size_group ()

## Types and Values

| CtkToolShell
struct | CtkToolShellIface

## Object Hierarchy

        GInterface
        ╰── CtkToolShell

## Prerequisites

CtkToolShell requires CtkWidget.

## Known Implementations

CtkToolShell is implemented by CtkToolItemGroup and CtkToolbar.

## Includes

    #include <ctk/ctk.h>

## Description

The CtkToolShell interface allows container widgets to provide additional information when embedding CtkToolItem widgets.

## Functions

### ctk_tool_shell_get_ellipsize_mode ()

    PangoEllipsizeMode
    ctk_tool_shell_get_ellipsize_mode (CtkToolShell *shell);

Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on `ctk_tool_item_get_ellipsize_mode()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current ellipsize mode of `shell`

Since: 2.20

### ctk_tool_shell_get_icon_size ()

    CtkIconSize
    ctk_tool_shell_get_icon_size (CtkToolShell *shell);

Retrieves the icon size for the tool shell. Tool items must not call this function directly, but rely on `ctk_tool_item_get_icon_size()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current size (CtkIconSize) for icons of `shell` .

[type int]

Since: 2.14

### ctk_tool_shell_get_orientation ()

    CtkOrientation
    ctk_tool_shell_get_orientation (CtkToolShell *shell);

Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on `ctk_tool_item_get_orientation()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current orientation of `shell`

Since: 2.14

### ctk_tool_shell_get_relief_style ()

    CtkReliefStyle
    ctk_tool_shell_get_relief_style (CtkToolShell *shell);

Returns the relief style of buttons on `shell` . Tool items must not call this function directly, but rely on `ctk_tool_item_get_relief_style()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

The relief style of buttons on `shell` .

Since: 2.14

### ctk_tool_shell_get_style ()

    CtkToolbarStyle
    ctk_tool_shell_get_style (CtkToolShell *shell);

Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on `ctk_tool_item_get_toolbar_style()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current style of `shell`

Since: 2.14

### ctk_tool_shell_get_text_alignment ()

    gfloat
    ctk_tool_shell_get_text_alignment (CtkToolShell *shell);

Retrieves the current text alignment for the tool shell. Tool items must not call this function directly, but rely on `ctk_tool_item_get_text_alignment()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current text alignment of `shell`

Since: 2.20

### ctk_tool_shell_get_text_orientation ()

    CtkOrientation
    ctk_tool_shell_get_text_orientation (CtkToolShell *shell);

Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on `ctk_tool_item_get_text_orientation()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current text orientation of `shell`

Since: 2.20

### ctk_tool_shell_rebuild_menu ()

    void
    ctk_tool_shell_rebuild_menu (CtkToolShell *shell);

Calling this function signals the tool shell that the overflow menu item for tool items have changed. If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.

Tool items must not call this function directly, but rely on `ctk_tool_item_rebuild_menu()` instead.

#### Parameters

shell | a CtkToolShell |

Since: 2.14

### ctk_tool_shell_get_text_size_group ()

    CtkSizeGroup *
    ctk_tool_shell_get_text_size_group (CtkToolShell *shell);

Retrieves the current text size group for the tool shell. Tool items must not call this function directly, but rely on `ctk_tool_item_get_text_size_group()` instead.

#### Parameters

shell | a CtkToolShell |

#### Returns

the current text size group of `shell` .

[transfer none]

Since: 2.20

## Types and Values

### CtkToolShell

    typedef struct _CtkToolShell CtkToolShell;

Dummy structure for accessing instances of CtkToolShellIface.

### struct CtkToolShellIface

    struct CtkToolShellIface {
      CtkIconSize        (*get_icon_size)        (CtkToolShell *shell);
      CtkOrientation     (*get_orientation)      (CtkToolShell *shell);
      CtkToolbarStyle    (*get_style)            (CtkToolShell *shell);
      CtkReliefStyle     (*get_relief_style)     (CtkToolShell *shell);
      void               (*rebuild_menu)         (CtkToolShell *shell);
      CtkOrientation     (*get_text_orientation) (CtkToolShell *shell);
      gfloat             (*get_text_alignment)   (CtkToolShell *shell);
      PangoEllipsizeMode (*get_ellipsize_mode)   (CtkToolShell *shell);
      CtkSizeGroup *     (*get_text_size_group)  (CtkToolShell *shell);
    };

Virtual function table for the CtkToolShell interface.

#### Members

`get_icon_size` () | mandatory implementation of `ctk_tool_shell_get_icon_size()`. |
`get_orientation` () | mandatory implementation of `ctk_tool_shell_get_orientation()`. |
`get_style` () | mandatory implementation of `ctk_tool_shell_get_style()`. |
`get_relief_style` () | optional implementation of `ctk_tool_shell_get_relief_style()`. |
`rebuild_menu` () | optional implementation of `ctk_tool_shell_rebuild_menu()`. |
`get_text_orientation` () | optional implementation of `ctk_tool_shell_get_text_orientation()`. |
`get_text_alignment` () | optional implementation of `ctk_tool_shell_get_text_alignment()`. |
`get_ellipsize_mode` () | optional implementation of `ctk_tool_shell_get_ellipsize_mode()`. |
`get_text_size_group` () | optional implementation of `ctk_tool_shell_get_text_size_group()`. |

## See Also

CtkToolbar, CtkToolItem