LibreOffice: com::sun::star::frame::FrameSearchFlag Constant Group Reference

LibreOffice LibreOffice 7.6 SDK API Reference

Loading...
Searching...
No Matches
Variables
com::sun::star::frame::FrameSearchFlag Constant Group Referencepublished

these types describe the algorithm to be used to search a frame More...

## Variables
const long | AUTO = 0
| no longer supported
const long | PARENT = 1
| allows search on the parent frames
const long | SELF = 2
| includes the start frame himself
const long | CHILDREN = 4
| includes all child frames of the start frame
const long | CREATE = 8
| frame will be created if not found
const long | SIBLINGS = 16
| includes the direct siblings of the start frame
const long | TASKS = 32
| allow the search outside the current sub task tree of the whole possible frame tree
const long | ALL = 23
| includes all frames except frames in other tasks sub trees but doesn't create any new frame
const long | GLOBAL = 55
| searches in the whole hierarchy of frames but doesn't create any new frame

## Detailed Description

these types describe the algorithm to be used to search a frame

Such flags will be used on methods XFrame::findFrame(), XDispatchProvider::queryDispatch() or XComponentLoader::loadComponentFromURL() if no special target frame name (e.g. "_blank", "_self") is used.

See also
  XFrame::findFrame()
  XDispatchProvider::queryDispatch()
  XComponentLoader::loadComponentFromURL()

Developers Guide
  Office Development - Handling Documents - Loading Documents - Target Frame

## Variable Documentation

## ◆ ALL

const long ALL = 23

includes all frames except frames in other tasks sub trees but doesn't create any new frame

## ◆ AUTO

const long AUTO = 0

no longer supported

Using of this flag will do nothing. Use right combination of other flags instead of this one.

Deprecated

## ◆ CHILDREN

const long CHILDREN = 4

includes all child frames of the start frame

Note: That means all direct children and of course her children too. Search doesn't stop at the next level inside the tree!

## ◆ CREATE

const long CREATE = 8

frame will be created if not found

## ◆ GLOBAL

const long GLOBAL = 55

searches in the whole hierarchy of frames but doesn't create any new frame

## ◆ PARENT

const long PARENT = 1

allows search on the parent frames

## ◆ SELF

const long SELF = 2

includes the start frame himself

## ◆ SIBLINGS

const long SIBLINGS = 16

includes the direct siblings of the start frame

Normally it's interpreted as search on the direct children of the parent only. But in combination with e.g. the CHILDREN flag it can include all children of it too.

## ◆ TASKS

const long TASKS = 32

allow the search outside the current sub task tree of the whole possible frame tree

If this flag isn't present, any search from bottom to top has to stop, if a top frame will be reached. It doesn't influence a search from top to bottom. But it can be used at the root of the frame tree to search on direct children of it only. Because the direct children of the root node are the root's of the task sub trees, which are top frames too. Instead of using the CHILDREN flag there, it's possible so to suppress a deeper search so.