BKE_workspace.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <string>
 
#include "DNA_listBase.h"
 
#include "BLI_compiler_attrs.h"
 
#include "BLI_vector.hh"
 
struct Main;
struct bScreen;
struct bToolRef;
struct WorkSpace;
struct WorkSpaceInstanceHook;
struct WorkSpaceLayout;
 
namespace blender::bke {
 
struct WorkSpaceStatusItem {
  int icon = 0;
  std::string text = {};
  float space_factor = 0.0f;
  bool inverted = false;
};
 
struct WorkSpaceRuntime {
  Vector<WorkSpaceStatusItem> status;
};
 
}  // namespace blender::bke
 
/* -------------------------------------------------------------------- */
 
WorkSpace *BKE_workspace_add(Main *bmain, const char *name);
void BKE_workspace_remove(Main *bmain, WorkSpace *workspace);
 
WorkSpaceInstanceHook *BKE_workspace_instance_hook_create(const Main *bmain, int winid);
void BKE_workspace_instance_hook_free(const Main *bmain, WorkSpaceInstanceHook *hook);

WorkSpaceLayout *BKE_workspace_layout_add(Main *bmain,
                                          WorkSpace *workspace,
                                          bScreen *screen,
                                          const char *name) ATTR_NONNULL();
void BKE_workspace_layout_remove(Main *bmain, WorkSpace *workspace, WorkSpaceLayout *layout)
    ATTR_NONNULL();
 
void BKE_workspace_relations_free(ListBase *relation_list);

 
/* -------------------------------------------------------------------- */
 
WorkSpaceLayout *BKE_workspace_layout_find(const WorkSpace *workspace, const bScreen *screen)
    ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
WorkSpaceLayout *BKE_workspace_layout_find_global(const Main *bmain,
                                                  const bScreen *screen,
                                                  WorkSpace **r_workspace) ATTR_NONNULL(1, 2);

WorkSpaceLayout *BKE_workspace_layout_iter_circular(const WorkSpace *workspace,
                                                    WorkSpaceLayout *start,
                                                    bool (*callback)(const WorkSpaceLayout *layout,
                                                                     void *arg),
                                                    void *arg,
                                                    bool iter_backward);
 
void BKE_workspace_tool_remove(WorkSpace *workspace, bToolRef *tref) ATTR_NONNULL(1, 2);

void BKE_workspace_tool_id_replace_table(WorkSpace *workspace,
                                         const int space_type,
                                         const int mode,
                                         const char *idname_prefix_skip,
                                         const char *replace_table[][2],
                                         int replace_table_num) ATTR_NONNULL(1, 5);

 
/* -------------------------------------------------------------------- */
 
#define GETTER_ATTRS ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
#define SETTER_ATTRS ATTR_NONNULL(1)
 
WorkSpace *BKE_workspace_active_get(WorkSpaceInstanceHook *hook) GETTER_ATTRS;
void BKE_workspace_active_set(WorkSpaceInstanceHook *hook, WorkSpace *workspace) SETTER_ATTRS;
WorkSpaceLayout *BKE_workspace_active_layout_get(const WorkSpaceInstanceHook *hook) GETTER_ATTRS;
void BKE_workspace_active_layout_set(WorkSpaceInstanceHook *hook,
                                     int winid,
                                     WorkSpace *workspace,
                                     WorkSpaceLayout *layout) SETTER_ATTRS;
bScreen *BKE_workspace_active_screen_get(const WorkSpaceInstanceHook *hook) GETTER_ATTRS;
void BKE_workspace_active_screen_set(WorkSpaceInstanceHook *hook,
                                     int winid,
                                     WorkSpace *workspace,
                                     bScreen *screen) SETTER_ATTRS;
 
const char *BKE_workspace_layout_name_get(const WorkSpaceLayout *layout) GETTER_ATTRS;
void BKE_workspace_layout_name_set(WorkSpace *workspace,
                                   WorkSpaceLayout *layout,
                                   const char *new_name) ATTR_NONNULL();
bScreen *BKE_workspace_layout_screen_get(const WorkSpaceLayout *layout) GETTER_ATTRS;

WorkSpaceLayout *BKE_workspace_active_layout_for_workspace_get(
    const WorkSpaceInstanceHook *hook, const WorkSpace *workspace) GETTER_ATTRS;
 
bool BKE_workspace_owner_id_check(const WorkSpace *workspace, const char *owner_id) ATTR_NONNULL();
 
void BKE_workspace_id_tag_all_visible(Main *bmain, int tag) ATTR_NONNULL();

void BKE_workspace_status_clear(WorkSpace *workspace);
 
#undef GETTER_ATTRS
#undef SETTER_ATTRS