Link Search Menu Expand Document

CLASSIFIER : GRNoteBook

uid: class-GRNoteBook-CVEViewer-MetaModel@g-scop.grenoble-inp.fr

About

Abstract

A GRNoteBook is a graphic node visualizing content depending button selection. In the image bellow, the page 1 is selected this a color selector is displayed, but there are two other contents on cubey and cube pages.

GRNotebook

To create a GRNoteBook just call:

notebook=cve.viewer.GRNoteBook()

Then use methods to add/remove pages and contents.

Class Diagram

Class diagram of class of GRNoteBook.

Inherits

attribute type cardinality
page GRNODE [0,-1]
header vstring [1,1]
size vvector [1,1]
side vint [1,1]
current vstring [1,1]
show-label vboolean [1,1]
show-icon vboolean [1,1]
show-background vboolean [1,1]

Methods

  • add_page(self,..) :

          Create a new page on the notebook
    		
          <: page : graphic node to be used as page content
          <: label : menu label
          <: newitem: if the content is new 
          <: local : apply local callbacks or ignore
    
  • remove_page(self,..) :

          Remove a notebook page
    		
          <: name : page label to be removed
    		
          TODO : should be developped. Currently void method
    
  • set_size(self,..) :

          Set note book size max. Subobjects are scaled to enter the notebook
    		
          <: X : X size
          <: X : Y size
          <: X : Z size
    
  • set_side(self,..) :

          Set side where button are positionnes
    		
          <: side : 0 : left, 1 = right
    
  • show_label(self,..) :

          Show label or not
    		
          <: show : boolean
    
  • show_icon(self,..) :

          Show icon or not
    		
          <: show : boolean
    
  • show_background(self,..) :

          Show background panel or not
    		
          <: show : boolean
    
  • set_current_page(self,..) :

          Set current page
    		
          <: defines which page must be rendered
    
  • get_current_page(self,..) :

          Get current page name
    		
          >: the page currently rendered