Information for presenting popups.
More...
#include <gdkmm/popuplayout.h>
Information for presenting popups.
Popups are positioned relative to their parent surface. The Gdk::PopupLayout class contains information that is necessary to do so.
- Since gtkmm 3.98:
◆ PopupLayout() [1/2]
Gdk::PopupLayout::PopupLayout |
( |
| ) |
|
|
delete |
◆ PopupLayout() [2/2]
◆ copy()
Glib::RefPtr<PopupLayout> Gdk::PopupLayout::copy |
( |
| ) |
const |
Create a new Gdk::PopupLayout and copy the contents of layout into it.
- Returns
- A copy of layout.
◆ create()
Create a popup layout description.
Used together with present() to describe how a popup surface should be placed and behave on-screen.
anchor_rect is relative to the top-left corner of the surface's parent. rect_anchor and surface_anchor determine anchor points on anchor_rect and surface to pin together.
The position of anchor_rect's anchor point can optionally be offset using set_offset(), which is equivalent to offsetting the position of surface.
- Parameters
-
anchor_rect | The anchor Gdk::Rectangle to align surface with. |
rect_anchor | The point on anchor_rect to align with surface's anchor point. |
surface_anchor | The point on surface to align with rect's anchor point. |
- Returns
- Newly created instance of Gdk::PopupLayout.
◆ equal()
bool Gdk::PopupLayout::equal |
( |
const Glib::RefPtr< const PopupLayout >& |
other | ) |
const |
Check whether layout and other has identical layout properties.
- Parameters
-
- Returns
true
if layout and other have identical layout properties, otherwise false
.
◆ get_anchor_hints()
AnchorHints Gdk::PopupLayout::get_anchor_hints |
( |
| ) |
const |
◆ get_anchor_rect()
Rectangle Gdk::PopupLayout::get_anchor_rect |
( |
| ) |
const |
Get the anchor rectangle.
- Returns
- The anchor rectangle.
◆ get_offset()
void Gdk::PopupLayout::get_offset |
( |
int & |
dx, |
|
|
int & |
dy |
|
) |
| |
Retrieves the offset for the anchor rectangle.
- Parameters
-
dx | Return location for the delta X coordinate. |
dy | Return location for the delta Y coordinate. |
◆ get_rect_anchor()
Gravity Gdk::PopupLayout::get_rect_anchor |
( |
| ) |
const |
Returns the anchor position on the anchor rectangle.
- Returns
- The anchor on the anchor rectangle.
◆ get_surface_anchor()
Gravity Gdk::PopupLayout::get_surface_anchor |
( |
| ) |
const |
Returns the anchor position on the popup surface.
- Returns
- The anchor on the popup surface.
◆ gobj() [1/2]
GdkPopupLayout* Gdk::PopupLayout::gobj |
( |
| ) |
|
Provides access to the underlying C instance.
◆ gobj() [2/2]
const GdkPopupLayout* Gdk::PopupLayout::gobj |
( |
| ) |
const |
Provides access to the underlying C instance.
◆ gobj_copy()
GdkPopupLayout* Gdk::PopupLayout::gobj_copy |
( |
| ) |
const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
◆ operator delete()
void Gdk::PopupLayout::operator delete |
( |
void * |
, |
|
|
std::size_t |
|
|
) |
| |
|
protected |
◆ operator=()
◆ reference()
void Gdk::PopupLayout::reference |
( |
| ) |
const |
Increment the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
◆ set_anchor_hints()
void Gdk::PopupLayout::set_anchor_hints |
( |
AnchorHints |
anchor_hints | ) |
|
Set new anchor hints.
The set anchor_hints determines how surface will be moved if the anchor points cause it to move off-screen. For example, Gdk::AnchorHints::FLIP_X will replace Gdk::Gravity::NORTH_WEST with Gdk::Gravity::NORTH_EAST and vice versa if surface extends beyond the left or right edges of the monitor.
- Parameters
-
◆ set_anchor_rect()
void Gdk::PopupLayout::set_anchor_rect |
( |
const Rectangle& |
anchor_rect | ) |
|
Set the anchor rectangle.
- Parameters
-
anchor_rect | The new anchor rectangle. |
◆ set_offset()
void Gdk::PopupLayout::set_offset |
( |
int |
dx, |
|
|
int |
dy |
|
) |
| |
Offset the position of the anchor rectangle with the given delta.
- Parameters
-
dx | X delta to offset the anchor rectangle with. |
dy | Y delta to offset the anchor rectangle with. |
◆ set_rect_anchor()
void Gdk::PopupLayout::set_rect_anchor |
( |
Gravity |
anchor | ) |
|
Set the anchor on the anchor rectangle.
- Parameters
-
anchor | The new rect anchor. |
◆ set_surface_anchor()
void Gdk::PopupLayout::set_surface_anchor |
( |
Gravity |
anchor | ) |
|
Set the anchor on the popup surface.
- Parameters
-
anchor | The new popup surface anchor. |
◆ unreference()
void Gdk::PopupLayout::unreference |
( |
| ) |
const |
Decrement the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
◆ wrap()
Glib::RefPtr< Gdk::PopupLayout > wrap |
( |
GdkPopupLayout * |
object, |
|
|
bool |
take_copy = false |
|
) |
| |
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
- Returns
- A C++ instance that wraps this C instance.